
############################
A3DEFRMDefinitionPatternType
############################

.. c:enum:: A3DEFRMDefinitionPatternType

   Feature definition pattern typesEnumerate the specific types of Definition Feature that can be found under akA3DFRMFeatureDefinitionType_Pattern.
   
   
      10.2
   
   
   
   Index
   =====
   
   .. rubric:: Enumerators
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_None`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_PatternMaster`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_PolygonalShape`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_SpiralShape`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_DirectionSpacing`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_AxialSpacing`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_RadialSpacing`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_PolygonalSpacing`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_SpiralSpacing`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_InstanceStatus`
   * :c:enumerator:`~kA3DFRMDefinitionPatternType_InstanceInformation`
   
   



.. rst-class:: kind-group kind-enumerator

.. rubric:: Enumerators
   :class: kind-group-title


.. c:enumerator:: kA3DFRMDefinitionPatternType_None

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_None** = ``0``
      
      Invalid Pattern Definition Type.
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_PatternMaster

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_PatternMaster**
      
      Type of Definition containing information specific to Pattern Master:
      
      
      - links to master features
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_PolygonalShape

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_PolygonalShape**
      
      Type of Definition containing information specific to Pattern of shape polygon (how the polygon is parameterized):
      
      
      
      - *Definition Position*\ : polygon center point
      - *Definition Direction*\ : normal
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : number of sides
      - *Value Angle*\ : total angle to apply instances
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_SpiralShape

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_SpiralShape**
      
      Type of Definition containing information specific to Pattern of shape spiral (how the spiral is parameterized):
      
      
      
      - *Definition Direction*\ : normal
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : number of turn
      - *IntegerData Boolean*\ : isClockwise, the spiral rotation direction
      - *Value Angle*\ : total angle to apply instances
      - *Value Length*\ : spiral radial step (between each turn)
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_DirectionSpacing

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_DirectionSpacing**
      
      Type of Definition that define a pattern spacing along a linear direction:
      
      
      
      - *Definition Direction*\ : linear direction
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : instance count
      - *DoubleData ExtensionAndStep*\ : extension (first value) and steps (next values)
      - *DoubleData Unit*\ : length unit. *(optional)*
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_AxialSpacing

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_AxialSpacing**
      
      Type of Definition that define a pattern spacing along a angular direction (around an axis):
      
      
      
      - *Definition Position*\ : axis position
      - *Definition Direction*\ : axis direction
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : instance count
      - *DoubleData ExtensionAndStep*\ : extension (first value) and steps (next values)
      - *DoubleData Unit*\ : angle unit. *(optional)*
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_RadialSpacing

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_RadialSpacing**
      
      Type of Definition that define a pattern spacing along a radial direction.
      
      *This is used for the second direction in case of pattern with concentric circles/polygons: Pattern of type CyclicMultiple OR PolygonalMultiple*\ :
      
      
      
      - *IntegerData Count*\ : instance count
      - *DoubleData ExtensionAndStep*\ : extension (first value) and steps (next values)
      - *DoubleData Unit*\ : length unit. *(optional)*
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_PolygonalSpacing

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_PolygonalSpacing**
      
      Type of Definition that define a pattern spacing along a polygon:
      
      
      
      - *Definition PolygonalShape*\ : polygon shape, of typekA3DFRMDefinitionPatternType_PolygonalShape
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : instance count
      - *DoubleData ExtensionAndStep*\ : extension (first value) and steps (next values)
      - *DoubleData Unit*\ : length unit. *(optional)*
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_SpiralSpacing

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_SpiralSpacing**
      
      Type of Definition that define a pattern spacing along a spiral:
      
      
      
      - *Definition SpiralShape*\ : spiral shape, of typekA3DFRMDefinitionPatternType_SpiralShape
      
      - Parameter Definition:
      
      - *IntegerData Count*\ : instance count
      - *DoubleData ExtensionAndStep*\ : extension (first value) and steps (next values)
      - *DoubleData Unit*\ : length unit. *(optional)*
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_InstanceStatus

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_InstanceStatus**
      
      Type of Definition containing status of pattern instances:
      
      
      
      - *IntegerData Boolean*\ : specify if the instance is enable/disable. In case of boolean array, specify the status of all instances in the pattern.
      
      - Parameter Data:
      



.. c:enumerator:: kA3DFRMDefinitionPatternType_InstanceInformation

      .. rst-class:: sig-pretty-signature
      
         | **kA3DFRMDefinitionPatternType_InstanceInformation**
      
      Type of Definition containing information specific to a pattern instance.
      
      
      
      - *Definition Position*\ : instance position
      - *Definition InstanceStatus*\ : instance status, of typekA3DFRMDefinitionPatternType_InstanceStatus
      
      - Parameter Definition:
      
      - *IntegerData Index*\ : list of instance index for each pattern direction
      
      - Parameter Data:
      




