On Path Dimension

The On Path Dimension block provides four methods to define a location along a chain of curves:

• Arc Length
• % Arc Length
• Through Point (optional)
• % Parameter

The availability of these options to the user is controlled by the OptionMask property.

If a dimension value at the point location needs to be specified (to control some characteristic of a feature), this block should be accompanied by a Linear Dimension, Angular Dimension, Radius Dimension, or Expression block.

Path requirement

To allow this block to work correctly, a curve should be provided to the block, which will act as a path. This path can only be set through automation (not interactively in Block UI Styler).

Inherited general properties

• BlockID
• Enable
• Group
• Label
• Show
• Expanded

Block-specific properties

Property Name	Description	Access	Property Type	List of Values
BalloonTooltipText / BalloonTooltipImage / BalloonTooltipLayout	Standard balloon tooltip text/image/layout properties.	CIGS	String/String/Enum	See other blocks for value lists.
ExpressionObject	Specifies the Expression tied to the block.	IG	TaggedObject	Object of type NXOpen.Expression.
Formula	Specifies the formula for the expression, e.g. sin(30). How the evaluated value is interpreted depends on the LocationOption property.	CSG	String	Any string value representing a valid formula.
LocationOption	Specifies the type of location option used to traverse the handle along the path. (Options generated in the template code.)	CSG	Enum	Arc Length — length of curve from one end. % Arc Length — percentage along arc length. Through Point — location defined by passing through a point. % Parameter — percentage of the curve's parametric range.
OptionMask	Controls which of the four LocationOption choices are available/presented to the user.	—	(mask/enum)	Bitmask or set covering Arc Length, % Arc Length, Through Point, % Parameter.
Path	Specifies the path for this block.	SG	TaggedObject	Any tagged object representing the path, e.g., curve, spline, section, etc.
ShowFocusHandle	Specifies whether to show the Graphics Window Input Field (GWIF) when focus is not on the block. Valid only when ShowHandle is True.	CSG	Logical	True — GWIF is visible even when the block is not in focus. False — GWIF is visible only when the block is in focus.
Value	Specifies the double value. Interpretation depends on LocationOption.	CSG	Double	Any Double value.
WithScale	Specifies whether the slider bar is available on the block.	CIG	Logical	True — shows the slider bar. False — hides it.
MaximumValue	Specifies the maximum allowed value. Values greater are invalid; equal is valid if MaxInclusive is True.	CSG	Double	Any Double value.
MaxInclusive	See MaximumValue.	CSG	Logical	True — a value exactly equal to maximum is valid. False — invalid.
MinimumValue	Specifies the minimum allowed value (analogous to MaximumValue).	CSG	Double	Any Double value.
MinInclusive	See MinimumValue.	(implied CSG)	Logical	Same semantics as MaxInclusive, for the minimum.
PageIncrement / LineIncrement	Value by which to increment the scale on Page Up/Down or Left/Right arrow keys.	CSG	Double	Any integer value less than MaximumValue.
AdaptiveScaleLimits	Specifies whether the scale should be adaptive.	CSG	Logical	TRUE — use Adaptive Scale. FALSE — do not use Adaptive Scale.

Access column legend

Character	Stands for	Meaning
C	Creation	Modifiable interactively in Block UI Styler at design time.
I	Initialize	Modifiable at run time via NXOpen API, but only during the Initialize callback.
G	Get	Readable via NXOpen API in any callback.
S	Set	Modifiable at run time via NXOpen API in any callback.

Related Numbers blocks

Angular Dimension, Double, Double Table, Expression, Integer, Integer Table, Linear Dimension, Radius Dimension.