CircularPatternFeatures.createInput Method

Parent Object: CircularPatternFeatures
Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/CircularPatternFeatures.h>

Description

Creates a CircularPatternFeatureInput object. Use properties and methods on this object to define the circular pattern you want to create and then use the Add method, passing in the CircularPatternFeatureInput object.

Syntax

"circularPatternFeatures_var" is a variable referencing a CircularPatternFeatures object.

returnValue = circularPatternFeatures_var.createInput(inputEntities, axis)
"circularPatternFeatures_var" is a variable referencing a CircularPatternFeatures object.

#include <Fusion/Features/CircularPatternFeatures.h>

returnValue = circularPatternFeatures_var->createInput(inputEntities, axis);
"circularPatternFeatures_var" is a variable referencing a CircularPatternFeatures object.

returnValue = circularPatternFeatures_var.createInput(inputEntities, axis);

Return Value

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

Parameters

Name Type Description
inputEntities ObjectCollection An ObjectCollection of the entities to pattern. The collection can contain BRepFace, PartFeature, BRepBody, or Occurrence objects. All of the entities provided must be the same type. For example, it must contain only bodies and can't contain both bodies and faces.

You can also pattern ConstructionPoint, ConstructionAxis, and ConstructionPlane objects. When patterning any construction geometry, only one entity can be patterned at a time, so the ObjectCollection must contain a single item.
axis Base Input linear entity or the entity has axis that defines axis of circular pattern. This can be a sketch line, linear edge, construction axis, an edge/sketch curve that defines an axis (circle, etc.) or a face that defines an axis (cylinder, cone, torus, etc.).

Samples

Name Description
CircularPattern Feature API Sample

Demonstrates creating a new circular pattern feature.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Version

Introduced in version November 2014