PatternCircular Method (ISketchManager)

PatternCircular Method (ISketchManager) | Send Feedback
See Also Example

BasePatternOn
  Base pattern type as defined in dsBasePatternOn_e

AngleBetween
  Angle between the base points of the pattern entities and the center of the pattern; valid when dsBasePatternOn is dsBasePatternOn_e.AngleBetweenAndElementsNumbers or dsBasePatternOn_e.dsBasePatternOn_FillAngleAndAngleBetween; in radians

FillAngle
  Positive or negative value for the fill angle; valid when BasePatternOn is dsBasePatternOn_e.dsBasePatternOn_FillAngleAndAngleBetween or dsBasePatternOn_e.dsBasePatternOn_FillAngleAndElementsNumber; in radians

TotalNumber
  Total number of entities in the pattern, including the original entity

ElementBasePointX
  x coordinate of the base point of the pattern

ElementBasePointY
  y coordinate of the base point of the pattern

AxisPointX
  x coordinate for the center point of the pattern

AxisPointY
  y coordinate for the center point of the pattern

OrientElementsAboutAxis
  True to rotate the entities as they are patterned, false to align the entities to the source entity

EntityTypeLongArray
  Array of longs of the types of entities as defined in dsObjectType_e

EntitiesArray
  Array of entities to pattern

Creates a circular pattern of the specified entities.

# Syntax

Visual Basic |
--- | ---
    Sub PatternCircular( _
       ByVal BasePatternOn As dsBasePatternOn_e, _
       ByVal AngleBetween As System.Double, _
       ByVal FillAngle As System.Double, _
       ByVal TotalNumber As System.Integer, _
       ByVal ElementBasePointX As System.Double, _
       ByVal ElementBasePointY As System.Double, _
       ByVal AxisPointX As System.Double, _
       ByVal AxisPointY As System.Double, _
       ByVal OrientElementsAboutAxis As System.Boolean, _
       ByVal EntityTypeLongArray As System.Object, _
       ByVal EntitiesArray As System.Object _
    )

C# |
--- | ---
    void PatternCircular(
       dsBasePatternOn_e BasePatternOn,
       System.double AngleBetween,
       System.double FillAngle,
       System.int TotalNumber,
       System.double ElementBasePointX,
       System.double ElementBasePointY,
       System.double AxisPointX,
       System.double AxisPointY,
       System.bool OrientElementsAboutAxis,
       System.object EntityTypeLongArray,
       System.object EntitiesArray
    )

JavaScript |
--- | ---
    PatternCircular(
       BasePatternOn : String,
       AngleBetween : Number,
       FillAngle : Number,
       TotalNumber : Number,
       ElementBasePointX : Number,
       ElementBasePointY : Number,
       AxisPointX : Number,
       AxisPointY : Number,
       OrientElementsAboutAxis : Boolean,
       EntityTypeLongArray : Array,
       EntitiesArray : Array
    )

COM native C++ |
--- | ---
    HRESULT PatternCircular(
       dsBasePatternOn_e BasePatternOn,
       DOUBLE AngleBetween,
       DOUBLE FillAngle,
       LONG TotalNumber,
       DOUBLE ElementBasePointX,
       DOUBLE ElementBasePointY,
       DOUBLE AxisPointX,
       DOUBLE AxisPointY,
       VARIANT_BOOL OrientElementsAboutAxis,
       VARIANT EntityTypeLongArray,
       VARIANT EntitiesArray
    )

C++ |
--- | ---
    DSRESULT PatternCircular(
       dsBasePatternOn_e BasePatternOn,
       double AngleBetween,
       double FillAngle,
       long TotalNumber,
       double ElementBasePointX,
       double ElementBasePointY,
       double AxisPointX,
       double AxisPointY,
       bool OrientElementsAboutAxis,
       const dsLongArray& EntityTypeLongArray,
       const dsObjectPtrArray& EntitiesArray
    )

#### Parameters

BasePatternOn
  Base pattern type as defined in dsBasePatternOn_e
AngleBetween
  Angle between the base points of the pattern entities and the center of the pattern; valid when dsBasePatternOn is dsBasePatternOn_e.AngleBetweenAndElementsNumbers or dsBasePatternOn_e.dsBasePatternOn_FillAngleAndAngleBetween; in radians
FillAngle
  Positive or negative value for the fill angle; valid when BasePatternOn is dsBasePatternOn_e.dsBasePatternOn_FillAngleAndAngleBetween or dsBasePatternOn_e.dsBasePatternOn_FillAngleAndElementsNumber; in radians
TotalNumber
  Total number of entities in the pattern, including the original entity
ElementBasePointX
  x coordinate of the base point of the pattern
ElementBasePointY
  y coordinate of the base point of the pattern
AxisPointX
  x coordinate for the center point of the pattern
AxisPointY
  y coordinate for the center point of the pattern
OrientElementsAboutAxis
  True to rotate the entities as they are patterned, false to align the entities to the source entity
EntityTypeLongArray
  Array of longs of the types of entities as defined in dsObjectType_e
EntitiesArray
  Array of entities to pattern

# Example

Create Circular Pattern (C#)
Create Circular Pattern (VB.NET)
Create Circular Pattern (VBA)
Create Circular Pattern (JavaScript)

# See Also

####

ISketchManager Interface
ISketchManager Members
ISketchManager::PatternLinear Method
ISketchManager::Pattern3DLinear Method
ISketchManager::PatternCircular Method
ISketchManager::Pattern3DCircular Method

# Availability

DraftSight V1R1.3