DisplayNodalCsysBuilder Class

class NXOpen.CAE.DisplayNodalCsysBuilder

Bases: NXOpen.Builder

Represents a CAE.DisplayNodalCsysBuilder.

To create a new instance of this class, use NXOpen.CAE.NodeElementInfoManager.CreateDisplayNodalCsysBuilder()

Default values.

Property	Value
CsysTypeEnum	Displacement
SelectionTypeEnum	EntireModel

New in version NX12.0.0.

Properties

Property	Description
CsysTypeEnum	Returns or sets the coordinate system type
NodeSelector	Returns the selection of nodes to display coordinate systems
SelectionTypeEnum	Returns or sets the way selections will be displayed
Tag	Returns the Tag for this object.

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.
GetColorXAxis	Returns the color for direction one
GetColorYAxis	Returns the color for direction two
GetColorZAxis	Returns the color for direction three
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.
SetColorXAxis	Sets the color for direction one
SetColorYAxis	Sets the color for direction two
SetColorZAxis	Sets the color for direction three
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

DisplayNodalCsysBuilderDisplayNodalCsysType Enumeration	the options to specify the type of coordinate system to display
DisplayNodalCsysBuilderNodesToDisplayType Enumeration	the options to specify the scope of nodes to select

Property Detail

CsysTypeEnum

DisplayNodalCsysBuilder.CsysTypeEnum

Returns or sets the coordinate system type

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

Getter Method

Signature CsysTypeEnum

Returns: Return type:NXOpen.CAE.DisplayNodalCsysBuilderDisplayNodalCsysType

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature CsysTypeEnum

Parameters:csysTypeEnum (NXOpen.CAE.DisplayNodalCsysBuilderDisplayNodalCsysType) –

New in version NX12.0.0.

License requirements: None.

NodeSelector

DisplayNodalCsysBuilder.NodeSelector

Returns the selection of nodes to display coordinate systems

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

Getter Method

Signature NodeSelector

Returns: Return type:NXOpen.CAE.SelectFENodeList

New in version NX12.0.0.

License requirements: None.

SelectionTypeEnum

DisplayNodalCsysBuilder.SelectionTypeEnum

Returns or sets the way selections will be displayed

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

Getter Method

Signature SelectionTypeEnum

Returns: Return type:NXOpen.CAE.DisplayNodalCsysBuilderNodesToDisplayType

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature SelectionTypeEnum

Parameters:selectionTypeEnum (NXOpen.CAE.DisplayNodalCsysBuilderNodesToDisplayType) –

New in version NX12.0.0.

License requirements: None.

Method Detail

GetColorXAxis

DisplayNodalCsysBuilder.GetColorXAxis

Returns the color for direction one

Signature GetColorXAxis()

Returns: Return type:Id

New in version NX12.0.0.

License requirements: None.

GetColorYAxis

DisplayNodalCsysBuilder.GetColorYAxis

Returns the color for direction two

Signature GetColorYAxis()

Returns: Return type:Id

New in version NX12.0.0.

License requirements: None.

GetColorZAxis

DisplayNodalCsysBuilder.GetColorZAxis

Returns the color for direction three

Signature GetColorZAxis()

Returns: Return type:Id

New in version NX12.0.0.

License requirements: None.

SetColorXAxis

DisplayNodalCsysBuilder.SetColorXAxis

Sets the color for direction one

Signature SetColorXAxis(xAxisColor)

Parameters:xAxisColor (Id) –

New in version NX12.0.0.

License requirements: None.

SetColorYAxis

DisplayNodalCsysBuilder.SetColorYAxis

Sets the color for direction two

Signature SetColorYAxis(yAxisColor)

Parameters:yAxisColor (Id) –

New in version NX12.0.0.

License requirements: None.

SetColorZAxis

DisplayNodalCsysBuilder.SetColorZAxis

Sets the color for direction three

Signature SetColorZAxis(zAxisColor)

Parameters:zAxisColor (Id) –

New in version NX12.0.0.

License requirements: None.

Validate

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