OrientGeomBuilder Class

class NXOpen.CAM.OrientGeomBuilder

Bases: NXOpen.CAM.NCGroupBuilder

Represents a OrientGeom Builder

This is an abstract class, and cannot be instantiated.

New in version NX5.0.0.

Properties

Property Description
CycleEvent Returns the cycle event
CycleTable Returns the cycle
Description Returns or sets the description
EndUdeSet Returns the end ude set
FixtureOffsetBuilder Returns the Fixture Offset builder
LayoutCiBuilder Returns the Save Layer/Layout builder
LinkRcsToMcs Returns or sets the link RCS to MCS
Mcs Returns or sets the MCS
OptimizationMethod Returns or sets the optim method
Rcs Returns or sets the RCS
StartUdeSet Returns the start ude set
Tag Returns the Tag for this object.
ToolAxisVector Returns or sets the tool axis vector

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.
GetCsysPurposeMode Returns the CSYS purpose
GetCustomizableItemBuilder Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames Returns the names for all customizable item ids
GetObject Returns the object currently being edited by this builder.
GetSpecialOutputMode Returns the Special Output
GetToolAxisMode Returns the tool axis mode
SetCsysPurposeMode Sets the CSYS purpose
SetSpecialOutputMode Sets the Special Output
SetToolAxisMode Sets the tool axis mode
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

OrientGeomBuilderCsysPurposeModes Enumeration The CSYS purpose mode options
OrientGeomBuilderSpecialOutputModes Enumeration The special output mode options
OrientGeomBuilderToolAxisModes Enumeration the tool axis mode options

Property Detail

FixtureOffsetBuilder

OrientGeomBuilder.FixtureOffsetBuilder

Returns the Fixture Offset builder

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

Getter Method

Signature FixtureOffsetBuilder

Returns:the fixture offset builder
Return type:NXOpen.CAM.InheritableIntBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LayoutCiBuilder

OrientGeomBuilder.LayoutCiBuilder

Returns the Save Layer/Layout builder

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

Getter Method

Signature LayoutCiBuilder

Returns:the save layer/layout builder
Return type:NXOpen.CAM.LayoutCiBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LinkRcsToMcs

OrientGeomBuilder.LinkRcsToMcs

Returns or sets the link RCS to MCS

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

Getter Method

Signature LinkRcsToMcs

Returns:the link RCS to MCS value
Return type:bool

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature LinkRcsToMcs

Parameters:linkRcsToMcs (bool) – the link RCS to MCS value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Mcs

OrientGeomBuilder.Mcs

Returns or sets the MCS

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

Getter Method

Signature Mcs

Returns:the MCS
Return type:NXOpen.CartesianCoordinateSystem

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Mcs

Parameters:mcs (NXOpen.CartesianCoordinateSystem) – the MCS

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Rcs

OrientGeomBuilder.Rcs

Returns or sets the RCS

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

Getter Method

Signature Rcs

Returns:the MCS
Return type:NXOpen.CartesianCoordinateSystem

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature Rcs

Parameters:rcs (NXOpen.CartesianCoordinateSystem) – the MCS

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ToolAxisVector

OrientGeomBuilder.ToolAxisVector

Returns or sets the tool axis vector

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

Getter Method

Signature ToolAxisVector

Returns:the vector tag
Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

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

Setter Method

Signature ToolAxisVector

Parameters:toolAxisVector (NXOpen.NXObject) – the vector tag

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

GetCsysPurposeMode

OrientGeomBuilder.GetCsysPurposeMode

Returns the CSYS purpose

Signature GetCsysPurposeMode()

Returns:the CSYS purpose mode
Return type:NXOpen.CAM.OrientGeomBuilderCsysPurposeModes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GetSpecialOutputMode

OrientGeomBuilder.GetSpecialOutputMode

Returns the Special Output

Signature GetSpecialOutputMode()

Returns:the special output mode
Return type:NXOpen.CAM.OrientGeomBuilderSpecialOutputModes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GetToolAxisMode

OrientGeomBuilder.GetToolAxisMode

Returns the tool axis mode

Signature GetToolAxisMode()

Returns:the integer value
Return type:NXOpen.CAM.OrientGeomBuilderToolAxisModes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SetCsysPurposeMode

OrientGeomBuilder.SetCsysPurposeMode

Sets the CSYS purpose

Signature SetCsysPurposeMode(csysPurposeMode)

Parameters:csysPurposeMode (NXOpen.CAM.OrientGeomBuilderCsysPurposeModes) – the CSYS purpose mode

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SetSpecialOutputMode

OrientGeomBuilder.SetSpecialOutputMode

Sets the Special Output

Signature SetSpecialOutputMode(specialOutputMode)

Parameters:specialOutputMode (NXOpen.CAM.OrientGeomBuilderSpecialOutputModes) – the special output mode

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SetToolAxisMode

OrientGeomBuilder.SetToolAxisMode

Sets the tool axis mode

Signature SetToolAxisMode(toolAxisMode)

Parameters:toolAxisMode (NXOpen.CAM.OrientGeomBuilderToolAxisModes) – the integer value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Validate

OrientGeomBuilder.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.