GeometricRelationship.offsetOrAngleValue Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

This property is used when creating a new joint or assembly constraint and defines the offset or angle associated with this geometric relationship. The value defaults to 0, but can be set with a ValueInput defining a length or angle. It can be either a real value, which will be in centimeters or radians, or a string, which is an expression whose units are length or angle.

If the GeometricRelationship is associated with an existing joint or assembly constraint (the isTemporary property is false), this property will return null and fail if set. To get and set the value in this case you should use the offsetOrAngle property to access the controlling parameter.

Syntax

# Get the value of the property.
propertyValue = geometricRelationship_var.offsetOrAngleValue

# Set the value of the property.
geometricRelationship_var.offsetOrAngleValue = propertyValue

#include <Fusion/Components/GeometricRelationship.h>

// Get the value of the property.
Ptr<ValueInput> propertyValue = geometricRelationship_var->offsetOrAngleValue();

// Set the value of the property, where value_var is a ValueInput.
bool returnValue = geometricRelationship_var->offsetOrAngleValue(value_var);

Property Value

Version