OffsetCenterPointBuilder Class

class NXOpen.Annotations.OffsetCenterPointBuilder

Bases: NXOpen.Annotations.BaseSymbolBuilder

Represents a NXOpen.Annotations.OffsetCenterPoint builder

To create a new instance of this class, use NXOpen.Annotations.OffsetCenterPointCollection.CreateOffsetCenterPointBuilder()

Default values.

Property Value
CenterCross 3.175 (millimeters part), 0.125 (inches part)
DisplayStyle CenterPoint
Distance 0
Extension 6.35 (millimeters part), 0.25 (inches part)
Gap 1.5875 (millimeters part), 0.0625 (inches part)
OffsetMethod HorizontalDistanceFromArc
Width Thin

New in version NX6.0.0.

Properties

Property Description
CenterCross Returns or sets the center cross size
Color Returns or sets the color
DisplayStyle Returns or sets the display style
Distance Returns or sets the offset distance, valid for all offset method types except those by position
Extension Returns or sets the extension
Gap Returns or sets the gap
Inherit Returns the inherit
Location Returns the location
OffsetMethod Returns or sets the offset method
OffsetPosition Returns or sets the offset position, valid for position offset methods
Tag Returns the Tag for this object.
Width Returns or sets the width

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

OffsetCenterPointBuilderDisplay Enumeration the valid types of display styles
OffsetCenterPointBuilderOffset Enumeration the valid offset method types
OffsetCenterPointBuilderThickness Enumeration the valid types of offset center point thickness

Property Detail

CenterCross

OffsetCenterPointBuilder.CenterCross

Returns or sets the center cross size

-------------------------------------

Getter Method

Signature CenterCross

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CenterCross

Parameters:centerCross (float) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Color

OffsetCenterPointBuilder.Color

Returns or sets the color

-------------------------------------

Getter Method

Signature Color

Returns:
Return type:Id

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Color

Parameters:color (Id) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

DisplayStyle

OffsetCenterPointBuilder.DisplayStyle

Returns or sets the display style

-------------------------------------

Getter Method

Signature DisplayStyle

Returns:
Return type:NXOpen.Annotations.OffsetCenterPointBuilderDisplay

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayStyle

Parameters:display (NXOpen.Annotations.OffsetCenterPointBuilderDisplay) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Distance

OffsetCenterPointBuilder.Distance

Returns or sets the offset distance, valid for all offset method types except those by position

-------------------------------------

Getter Method

Signature Distance

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Distance

Parameters:distance (float) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Extension

OffsetCenterPointBuilder.Extension

Returns or sets the extension

-------------------------------------

Getter Method

Signature Extension

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Extension

Parameters:extension (float) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Gap

OffsetCenterPointBuilder.Gap

Returns or sets the gap

-------------------------------------

Getter Method

Signature Gap

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Gap

Parameters:gap (float) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Inherit

OffsetCenterPointBuilder.Inherit

Returns the inherit

-------------------------------------

Getter Method

Signature Inherit

Returns:
Return type:NXOpen.SelectNXObject

New in version NX6.0.0.

License requirements: None.

Location

OffsetCenterPointBuilder.Location

Returns the location

-------------------------------------

Getter Method

Signature Location

Returns:
Return type:NXOpen.SelectNXObject

New in version NX6.0.0.

License requirements: None.

OffsetMethod

OffsetCenterPointBuilder.OffsetMethod

Returns or sets the offset method

-------------------------------------

Getter Method

Signature OffsetMethod

Returns:
Return type:NXOpen.Annotations.OffsetCenterPointBuilderOffset

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature OffsetMethod

Parameters:offsetMethod (NXOpen.Annotations.OffsetCenterPointBuilderOffset) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

OffsetPosition

OffsetCenterPointBuilder.OffsetPosition

Returns or sets the offset position, valid for position offset methods

-------------------------------------

Getter Method

Signature OffsetPosition

Returns:
Return type:NXOpen.Point3d

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature OffsetPosition

Parameters:point (NXOpen.Point3d) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Width

OffsetCenterPointBuilder.Width

Returns or sets the width

-------------------------------------

Getter Method

Signature Width

Returns:
Return type:NXOpen.Annotations.OffsetCenterPointBuilderThickness

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Width

Parameters:width (NXOpen.Annotations.OffsetCenterPointBuilderThickness) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Method Detail

Validate

OffsetCenterPointBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.