RectangularPatternFeatures.createInput Method

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

Syntax

Python
C++
TypeScript 🧪

"rectangularPatternFeatures_var" is a variable referencing a RectangularPatternFeatures object.

returnValue = rectangularPatternFeatures_var.createInput(inputEntities, directionOneEntity, quantityOne, distanceOne, patternDistanceType)

"rectangularPatternFeatures_var" is a variable referencing a RectangularPatternFeatures object.

#include <Fusion/Features/RectangularPatternFeatures.h>

returnValue = rectangularPatternFeatures_var->createInput(inputEntities, directionOneEntity, quantityOne, distanceOne, patternDistanceType);

"rectangularPatternFeatures_var" is a variable referencing a RectangularPatternFeatures object.

returnValue = rectangularPatternFeatures_var.createInput(inputEntities, directionOneEntity, quantityOne, distanceOne, patternDistanceType);

Parameters

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.

directionOneEntity

Base

Specifies the entity used to define the first direction entity. This can be a linear edge, construction axis, sketch line or rectangular pattern feature. If a rectangular pattern feature is set, the directionOneEntity and directionTwoEntity properties return the same rectangular pattern feature.

quantityOne

ValueInput

Specifies the number of instances in the first direction.

distanceOne

ValueInput

Specifies the distance in the first direction. How this value is used depends on the value of the PatternDistanceType property. A negative value can be used to change the direction. If the value is ExtentPatternDistanceType then it defines the total distance of the pattern. If the value is SpacingPatternDistanceType then it defines the distance between each element.

patternDistanceType

PatternDistanceType

Specifies how the distance between elements is computed.

Samples

Manage Participant Bodies API Sample

Demonstrates how to manage participant During Cut operation. Same API can be used to manage participants During intersection also.

rectangularPattern.add

Demonstrates the rectangularPattern.add method using a selected body and two selected edges to define the directions.

RectangularPatternFeatures.createInput Method

Description

Syntax

Return Value

Parameters

Samples

Version

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

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.
directionOneEntity	Base	Specifies the entity used to define the first direction entity. This can be a linear edge, construction axis, sketch line or rectangular pattern feature. If a rectangular pattern feature is set, the directionOneEntity and directionTwoEntity properties return the same rectangular pattern feature.
quantityOne	ValueInput	Specifies the number of instances in the first direction.
distanceOne	ValueInput	Specifies the distance in the first direction. How this value is used depends on the value of the PatternDistanceType property. A negative value can be used to change the direction. If the value is ExtentPatternDistanceType then it defines the total distance of the pattern. If the value is SpacingPatternDistanceType then it defines the distance between each element.
patternDistanceType	PatternDistanceType	Specifies how the distance between elements is computed.