OnPathDimensionBuilder Class

class NXOpen.GeometricUtilities.OnPathDimensionBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Builds an on-path dimension

New in version NX5.0.0.

Properties

Property	Description
Expression	Returns the expression for the value of the dimension
IsFlipped	Returns or sets a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path
IsParameterUsed	Returns or sets a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).
IsPercentUsed	Returns or sets a flag indicating whether the expression represents the percentage along the path.
Path	Returns the path that the dimension is evaluated on.
Tag	Returns the Tag for this object.
ThroughPoint	Returns or sets the through point

Methods

Method	Description
Update	Updates this object if the path or through point location has changed.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

OnPathDimensionBuilderUpdateReason Enumeration

The type of update to perform

Property Detail

Expression

OnPathDimensionBuilder.Expression

Returns the expression for the value of the dimension

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

Getter Method

Signature Expression

Returns: Return type:NXOpen.Expression

New in version NX5.0.0.

License requirements: None.

IsFlipped

OnPathDimensionBuilder.IsFlipped

Returns or sets a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path

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

Getter Method

Signature IsFlipped

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IsFlipped

Parameters:flipped (bool) –

New in version NX5.0.0.

License requirements: None.

IsParameterUsed

OnPathDimensionBuilder.IsParameterUsed

Returns or sets a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).

When value is true, the value will always be expressed in terms of percentage (between 0 and 100) regardless of is_percent_used’s setting. This property must be used with care. Most referencing classes will only accept arclength values, and setting this property to true for those classes will result in a run time error. Consult the referencing class documentation to see if this value can be true for that particular operation.

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

Getter Method

Signature IsParameterUsed

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IsParameterUsed

Parameters:useParameter (bool) –

New in version NX5.0.0.

License requirements: None.

IsPercentUsed

OnPathDimensionBuilder.IsPercentUsed

Returns or sets a flag indicating whether the expression represents the percentage along the path.

If false, the expression represents the length along the path

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

Getter Method

Signature IsPercentUsed

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IsPercentUsed

Parameters:usePercent (bool) –

New in version NX5.0.0.

License requirements: None.

Path

OnPathDimensionBuilder.Path

Returns the path that the dimension is evaluated on.

Note: in some cases, the builder will not permit you to change the path

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

Getter Method

Signature Path

Returns: Return type:NXOpen.SelectObject

New in version NX5.0.0.

License requirements: None.

ThroughPoint

OnPathDimensionBuilder.ThroughPoint

Returns or sets the through point

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

Getter Method

Signature ThroughPoint

Returns: Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ThroughPoint

Parameters:throughPoint (NXOpen.Point) –

New in version NX5.0.0.

License requirements: None.

Method Detail

Update

OnPathDimensionBuilder.Update

Updates this object if the path or through point location has changed.

Call this function if the path is a section and you have added or removed curves from the section, or if there is a through point and the coordinates of the through point have changed.

Signature Update(updateReason)

Parameters:updateReason (NXOpen.GeometricUtilities.OnPathDimensionBuilderUpdateReason) –

New in version NX5.0.0.

License requirements: None.

Validate

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