`HexagonShape`

A hexagon shape.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
 
-- Create a hexagon shape

properties = cf.HexagonShape.GetDefaultProperties()
properties.Width = "1.5"
hexagonShape1 = application.Project.Definitions.PeriodicStructures.Shapes:AddHexagon(properties)

Inheritance

The HexagonShape object is derived from the Shape object.

The following objects are derived (specialisations) from the HexagonShape object:

StripHexagonShape

Usage locations

The HexagonShape object can be accessed from the following locations:

Methods
- ShapeCollection collection has method AddHexagon(table).

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)
Width: The hexagon width. (Read/Write ParametricExpression)

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

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Width

The hexagon width.

Type: ParametricExpression
Access: Read/Write

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.