ConstructionPlanePathDefinition.offset Property

Description

Returns the ModelParameter controlling the signed offset from the target along the path, or null when the plane was not created using setByPathToObject (Proportional or Absolute planes).

For To Object planes, this is the user-facing offset passed to setByPathToObject (positive or negative along the path from the target point). It is separate from the distance property, which holds the along-path position derived from the target entity. To change the value, use the properties on the returned ModelParameter object, or use redefineToObject to change path, target, or offset together.

Syntax

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

#include <Fusion/Construction/ConstructionPlanePathDefinition.h>

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

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

Property Value

Version