Geometry

A geometry object. All derived geometry objects share a set of common properties and methods that are listed here.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Create various geometry objects

cuboid = project.Contents.Geometry:AddCuboid(cf.Point(1,0,0),1,1,1)
line = project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,1))
sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1)
union = project.Contents.Geometry:Union({sphere, cuboid})

    -- Modify various properties of the union

union:ReverseFaceNormals()
union.Label = "LockedGeometry"
union.Locked = true

    -- Duplicate the sphere and convert it to primitive geometry

geometry = sphere:Duplicate():ConvertToPrimitive()

Inheritance

The Geometry object is derived from the Object object.

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

Usage locations

The Geometry object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Faulty
Indicates whether the geometry has faults. (Read only boolean)
Label
The object label. (Read/Write string)
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
MeshSettings
The locally defined mesh setting to use. (Read/Write MeshSettings)
Parent
The parent part of this geometry. If this is a top level part nil will be returned. (Read only Geometry)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Collection List

Edges
The collection of edges of the operator. (EdgeCollection of Edge.)
Faces
The collection of faces of the operator. (FaceCollection of Face.)
Regions
The collection of regions of the operator. (RegionCollection of Region.)
Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)
Wires
The collection of wires of the operator. (WireCollection of Edge.)

Method List

ConvertToPrimitive ()
Convert the geometry into its primitive base form, returning a new part without the concrete type properties. The reference to the original part will become invalid. (Returns a Geometry object.)
CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object object.)
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
Explode ()
Explode the geometry into separate surface and edge parts. The new parts represent a snapshot of the geometry at the time it was exploded. (Returns a List of Geometry 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.)
ReverseFaceNormals ()
Reverse the geometry face normals.
ReverseFaceNormals (faces List of Face)
Reverse the geometry face normals.
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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
Faulty
Indicates whether the geometry has faults.
Type
boolean
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity.
Type
boolean
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
MeshSettings
The locally defined mesh setting to use.
Type
MeshSettings
Access
Read/Write
Parent
The parent part of this geometry. If this is a top level part nil will be returned.
Type
Geometry
Access
Read only
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

Edges
The collection of edges of the operator.
Type
EdgeCollection
Faces
The collection of faces of the operator.
Type
FaceCollection
Regions
The collection of regions of the operator.
Type
RegionCollection
Transforms
The collection of transforms on the operator.
Type
TransformCollection
Wires
The collection of wires of the operator.
Type
WireCollection

Method Details

ConvertToPrimitive ()
Convert the geometry into its primitive base form, returning a new part without the concrete type properties. The reference to the original part will become invalid.
Return
Geometry
The new primitive geometry base.
CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
List of Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
Explode ()
Explode the geometry into separate surface and edge parts. The new parts represent a snapshot of the geometry at the time it was exploded.
Return
List of Geometry
The list of new surface and edge parts.
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.
ReverseFaceNormals ()
Reverse the geometry face normals.
ReverseFaceNormals (faces List of Face)
Reverse the geometry face normals.
Input Parameters
faces(List of Face)
The list of faces to reverse normal.
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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh.
Input Parameters
unlinkoption(UnlinkMeshOptionEnum)
Mesh ports are created. Solution entities are either keep with their original assignment or reassigned to the new port.
Return
Mesh
The unlinked mesh.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.