ConstructionPlanePathDefinition.distance Property

Description

Returns the ModelParameter that controls position along the path. To change the value, use the properties on the returned ModelParameter object.

For Proportional planes (setByPath with ProportionalPathDistanceType), this is the proportional distance (0 to 1) along the path.

For Absolute planes (setByPath with PhysicalPathDistanceType), this is the physical distance along the path.

For To Object planes (setByPathToObject), this is the computed along-path position where the path meets the target entity. The user-controlled signed shift from that target is returned by the offset property, not this property. To change To Object positioning, use redefineToObject or edit offset rather than distance alone.

Syntax

# Get the value of the property.
propertyValue = constructionPlanePathDefinition_var.distance

#include <Fusion/Construction/ConstructionPlanePathDefinition.h>

// Get the value of the property.
Ptr<ModelParameter> propertyValue = constructionPlanePathDefinition_var->distance();

// Get the value of the property.
propertyValue = constructionPlanePathDefinition_var.distance;

Property Value

Version