Share

CircularOccurrencePattern Object

Derived from: OccurrencePattern Object

Description

The CircularOccurrencePattern object represents a circular pattern of assembly occurrences.

Methods

Name Description
Delete Method that deletes the pattern.
GetReferenceKey Method that generates and returns the reference key for this entity.
Suppress Suppress the occurrence pattern.
Unsuppress Unsuppress the occurrence pattern.

Properties

Name Description
AngleOffset Property returning the Parameter object that controls the angle offset between pattern instances.
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
AxisEntity Gets/Sets the entity used to define the axis of the pattern.
AxisEntityNaturalDirection Gets/Sets whether the axis direction is in the natural direction of the axis entity or not.
ElementCount Property returning the Parameter object that controls the number of elements in the pattern.
HealthStatus Property that returns an enum indicating the current state of the object.
IsPatternElement Property that indicates whether this occurrence pattern is itself an element of a parent pattern. In the case where this occurrence pattern represents a pattern element, this property returns True. The PatternElement property can be used to get that pattern element.
LockRotation Read-write property that gets and sets whether the patterned elements keep the same rotation as their parent occurrences. This defaults to False when the CircularOccurrencePattern is just created indicates that the patterned elements will be rotated.
Name Gets/Sets the name for the pattern.
OccurrencePatternElements Property returning an OccurrencePatternElements collection object. The first element within this collection will contain the components that were provided as input for the pattern.
Parent Property that returns the parent of the object.
ParentComponents Property that gets and sets the components used as input for the pattern.
PatternElement Property that returns the pattern element this occurrence pattern represents. In the case where this occurrence pattern is not part of a parent pattern this property returns Nothing. The IsPatternElement property can be used to check if this occurrence pattern is part of a parent pattern.
PatternRadiusPoint Read-write property that gets and sets the point used to define the pattern radius against the rotation axis. This property returns Nothing when the LockRotation is False. When the LockRotation is set to True, this property returns a Point object indicating th.
PositioningMethod Read-write property that gets and sets the enum indicating the positioning method used for the component pattern.
Suppressed Returns the suppress state of the occurrence pattern.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets/Sets the Visible property for the pattern.

Accessed From

CircularOccurrencePatternProxy.NativeObject, OccurrencePatterns.AddCircularPattern

Derived Classes

CircularOccurrencePatternProxy

Version

Introduced in version 6

Was this information helpful?