Builds an on-path dimension More...

Inheritance diagram for NXOpen.GeometricUtilities.OnPathDimensionBuilder:

Public Types
enum	UpdateReason { Path = 1, ThroughPoint, All }
	The type of update to perform More...

Public Member Functions
unsafe void	Update (NXOpen.GeometricUtilities.OnPathDimensionBuilder.UpdateReason updateReason)
	Updates this object if the path or through point location has changed. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Expression	Expression `[get]`
	Returns the expression for the value of the dimension More...

unsafe bool	IsFlipped `[get, set]`
	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 More...

unsafe bool	IsParameterUsed `[get, set]`
	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). More...

unsafe bool	IsPercentUsed `[get, set]`
	Returns or sets a flag indicating whether the expression represents the percentage along the path. More...

unsafe NXOpen.SelectObject	Path `[get]`
	Returns the path that the dimension is evaluated on. More...

unsafe NXOpen.Point	ThroughPoint `[get, set]`
	Returns or sets the through point More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Builds an on-path dimension

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.GeometricUtilities.OnPathDimensionBuilder.UpdateReason

The type of update to perform

Enumerator
Path	Update because of the path may have changed
ThroughPoint	Update because the through point location may have changed
All	Update because either path or through point location may have changed

Member Function Documentation

unsafe void NXOpen.GeometricUtilities.OnPathDimensionBuilder.Update ( NXOpen.GeometricUtilities.OnPathDimensionBuilder.UpdateReason updateReason )

inline

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.

Created in NX5.0.0

License requirements: None.

Parameters

updateReason

unsafe bool NXOpen.GeometricUtilities.OnPathDimensionBuilder.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Expression NXOpen.GeometricUtilities.OnPathDimensionBuilder.Expression

get

Returns the expression for the value of the dimension

Created in NX5.0.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.OnPathDimensionBuilder.IsFlipped

getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.OnPathDimensionBuilder.IsParameterUsed

getset

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.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.OnPathDimensionBuilder.IsPercentUsed

getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectObject NXOpen.GeometricUtilities.OnPathDimensionBuilder.Path

get

Returns the path that the dimension is evaluated on.

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

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.Point NXOpen.GeometricUtilities.OnPathDimensionBuilder.ThroughPoint

getset

Returns or sets the through point

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

The documentation for this class was generated from the following file:

GeometricUtilities_OnPathDimensionBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation