HorizontalReference Class

class NXOpen.GeometricUtilities.HorizontalReference

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

the horizontal reference vector definition.

New in version NX8.0.0.

Properties

Property Description
Flip Returns or sets the 2D Selection flip attribute.
HorizontalRefObject Returns the direction object.
HorizontalRefVector Returns or sets the horizontal reference vector
RotationAngle Returns the rotation angle wrt horizontal reference direction
Tag Returns the Tag for this object.

Methods

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

Property Detail

Flip

HorizontalReference.Flip

Returns or sets the 2D Selection flip attribute.

This function flips the selection object of the 2D pattern

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

Getter Method

Signature Flip

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Flip

Parameters:flip (bool) –

New in version NX8.0.0.

License requirements: None.

HorizontalRefObject

HorizontalReference.HorizontalRefObject

Returns the direction object.

This function gets reference vector of the 2D pattern. This call will result in an Exception if not called in 2D mode.

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

Getter Method

Signature HorizontalRefObject

Returns:
Return type:NXOpen.SelectNXObject

New in version NX8.0.0.

License requirements: None.

HorizontalRefVector

HorizontalReference.HorizontalRefVector

Returns or sets the horizontal reference vector

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

Getter Method

Signature HorizontalRefVector

Returns:
Return type:NXOpen.Direction

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature HorizontalRefVector

Parameters:horizontalRefVector (NXOpen.Direction) –

New in version NX8.0.0.

License requirements: None.

RotationAngle

HorizontalReference.RotationAngle

Returns the rotation angle wrt horizontal reference direction

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

Getter Method

Signature RotationAngle

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Method Detail

Validate

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