SpiralCrossShape
A spiral cross shape.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create a spiral cross shape cross = project.Definitions.PeriodicStructures.Shapes:AddSpiralCross(2.0, 1.0, 0.6, 0.2)
Inheritance
The SpiralCrossShape object is derived from the Shape object.
Usage locations
The SpiralCrossShape object can be accessed from the following locations:
- Methods
- ShapeCollection collection has method AddSpiralCross(table).
- ShapeCollection collection has method AddSpiralCross(Expression, Expression, Expression, Expression).
Property List
- ArmLength
- The spiral cross arm length. (Read/Write ParametricExpression)
- EdgeLength
- The spiral cross edge length. (Read/Write ParametricExpression)
- Label
- The object label. (Read/Write string)
- SpiralLength
- The spiral cross spiral length. (Read/Write ParametricExpression)
- StripWidth
- The spiral cross strip width. (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
Method List
- BuildGeometry ()
- Creates the full geometry representation of the shape. (Returns a Geometry object.)
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- ArmLength
- The spiral cross arm length.
- Type
- ParametricExpression
- Access
- Read/Write
- EdgeLength
- The spiral cross edge length.
- Type
- ParametricExpression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- SpiralLength
- The spiral cross spiral length.
- Type
- ParametricExpression
- Access
- Read/Write
- StripWidth
- The spiral cross strip width.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- BuildGeometry ()
- Creates the full geometry representation of the shape.
- Return
- Geometry
- The shape geometry.
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.