Arrange2DEnvelopeInput.placementClearance 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

Specifies the distance of the components and the bottom of the envelope. This raises the components above the X-Y plane of the specified construction plane.

This value will become a parameter when the arrangement is created. If the ValueInput is created using a real number it is in centimeters. If you use a string, it is evaluated the same as a value would be in the command dialog and uses the current document units. For example, if the document units are inch and you specific "0.25" it will result in 1/4 inch clearance. You can also specify the units as part of the expression, such as "0.25 in + 2 mm". And you can define equations like "ToolDia + 2 mm" where "ToolDia" is an existing parameter.

Syntax

# Get the value of the property.
propertyValue = arrange2DEnvelopeInput_var.placementClearance

# Set the value of the property.
arrange2DEnvelopeInput_var.placementClearance = propertyValue

#include <Fusion/Arrange/Arrange2DEnvelopeInput.h>

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

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

Property Value

Version