OffsetFeatures.createInput Method

Creates a OffsetFeatureInput object. Use properties and methods on this object to define the offset feature you want to create and then use the Add method, passing in the OffsetFeatureInput object to create the feature.

Syntax

Python
C++

"offsetFeatures_var" is a variable referencing an OffsetFeatures object.

# Uses no optional arguments.
returnValue = offsetFeatures_var.createInput(entities, distance, operation)

# Uses optional arguments.
returnValue = offsetFeatures_var.createInput(entities, distance, operation, isChainSelection)

"offsetFeatures_var" is a variable referencing an OffsetFeatures object.

#include <Fusion/Features/OffsetFeatures.h>

// Uses no optional arguments.
returnValue = offsetFeatures_var->createInput(entities, distance, operation);

// Uses optional arguments.
returnValue = offsetFeatures_var->createInput(entities, distance, operation, isChainSelection);

Parameters

entities

ObjectCollection

An ObjectCollection containing the BRepFace objects to offset. Additional faces may be automatically used depending on the value of the isChainSelection argument. Input faces need not be from the same body.

distance

ValueInput

ValueInput object that defines the offset distance. A positive value is in the positive normal direction of the face being offset.

operation

FeatureOperations

The feature operation to perform. 'NewBodyFeatureOperation' and 'NewComponentFeatureOperation' are the options supported.

isChainSelection

boolean

A boolean value for setting whether or not faces that are tangentially connected to the input faces (if any) will be included in the offset. The default value is true.

This is an optional argument whose default value is True.

Samples

offsetFeatures.add

Demonstrates the offsetFeatures.add method. This is the equivalent of the Offset command in the SURFACE tab.

Offset Feature API Sample

Demonstrates creating a new offset feature

Type	Description
OffsetFeatureInput	Returns the newly created OffsetFeatureInput object or null if the creation failed.

OffsetFeatures.createInput Method

Description

Syntax

Return Value

Parameters

Samples

Version

Name	Type	Description
entities	ObjectCollection	An ObjectCollection containing the BRepFace objects to offset. Additional faces may be automatically used depending on the value of the isChainSelection argument. Input faces need not be from the same body.
distance	ValueInput	ValueInput object that defines the offset distance. A positive value is in the positive normal direction of the face being offset.
operation	FeatureOperations	The feature operation to perform. 'NewBodyFeatureOperation' and 'NewComponentFeatureOperation' are the options supported.
isChainSelection	boolean	A boolean value for setting whether or not faces that are tangentially connected to the input faces (if any) will be included in the offset. The default value is true. This is an optional argument whose default value is True.