UserCoordinateSystemInput.offsetZ 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

Gets and sets the value that defines the Z offset direction. This defaults to zero if it's not specified. The value defines a distance and if the ValueInput is defined using the createByReal method the value is assumed to be centimeters.

Syntax

# Get the value of the property.
propertyValue = userCoordinateSystemInput_var.offsetZ

# Set the value of the property.
userCoordinateSystemInput_var.offsetZ = propertyValue

#include <Fusion/Construction/UserCoordinateSystemInput.h>

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

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

Property Value

Version