OpenRingShape
A open ring shape.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create an open ring shape ring = project.Definitions.PeriodicStructures.Shapes:AddOpenRing(1.5, 1.2, 10.0, 30.0)
Inheritance
The OpenRingShape object is derived from the RingShape object.
The following objects are derived (specialisations) from the OpenRingShape object:
Usage locations
The OpenRingShape object can be accessed from the following locations:
- Methods
- ShapeCollection collection has method AddOpenRing(table).
- ShapeCollection collection has method AddOpenRing(Expression, Expression, Expression, Expression).
Property List
- GapAngle
- The angle of the ring opening. (Read/Write ParametricExpression)
- InnerRadius
- The ring inner radius. (Read/Write ParametricExpression)
- Label
- The object label. (Read/Write string)
- OuterRadius
- The ring outer radius. (Read/Write ParametricExpression)
- StartAngle
- The angle the ring opening starts at. (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
- GapAngle
- The angle of the ring opening.
- Type
- ParametricExpression
- Access
- Read/Write
- InnerRadius
- The ring inner radius.
- Type
- ParametricExpression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- OuterRadius
- The ring outer radius.
- Type
- ParametricExpression
- Access
- Read/Write
- StartAngle
- The angle the ring opening starts at.
- 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.