`GeometryGroup`

A group of geometry.

Example

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

    -- Add some geometry

cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)
flare = project.Contents.Geometry:AddFlare(cf.Point(0.5, 0.5, 1), 1, -1, 0.5, 0, 1)

-- Add the geometry to the group

group = project.Contents.Geometry:CreateGroup()
group:MoveIn({cuboid, flare})

    -- Apply a transform to the group

from = cf.Point(0, 0, 0)
to = cf.Point(1, 1, 1)
translate = group.Transforms:AddTranslate(from, to)

Inheritance

The GeometryGroup object is derived from the Object object.

Usage locations

The GeometryGroup object can be accessed from the following locations:

Methods
- GeometryGroupCollection collection has method Item(number).
- GeometryGroupCollection collection has method Item(string).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count: The number of Geometry items in the collection. (Read only number)
Included: A boolean value defining if an entity is excluded or included. (Read/Write boolean)
Label: The object label. (Read/Write string)
LocalWorkplane: The source workplane. (Read/Write LocalWorkplane)
Locked: A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
Type: The object type string. (Read only string)

Collection List

Transforms: The collection of transforms on the operator. (TransformCollection of Transform.)

Method List

Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
CopyAndMirror (properties table): Apply a copy and mirror using a table defining the properties. (Returns a 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.
Disassemble (): Disassembles the group.
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.)
Item (index number): Returns the Geometry for the given index in the collection. (Returns a Geometry object.)
Item (label string): Returns the Geometry for the given label in the collection. (Returns a Geometry object.)
Items (): Returns a table of Geometry items. (Returns a UnsupportedType(List of Geometry) object.)
MoveOut (geometry List of Object): Moves the specified geometry parts out of this geometry group.
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.
UniqueName (label string): Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string 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

Count

The number of Geometry items in the collection.

Type: number
Access: Read only

Included

A boolean value defining if an entity is excluded or included.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LocalWorkplane

The source workplane.

Type: LocalWorkplane
Access: Read/Write

Locked

A boolean that indicates whether the entity or it's ancestor is locked or not.

Type: boolean
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

Transforms

The collection of transforms on the operator.

Type: TransformCollection

Method Details

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

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

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.

Disassemble ()

Disassembles the group.

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.

Item (index number)

Returns the Geometry for the given index in the collection.

Input Parameters

index(number): The index of the Geometry.

Return

Geometry: The item in the collection

Item (label string)

Returns the Geometry for the given label in the collection.

Input Parameters

label(string): The label of the Geometry.

Return

Geometry: The item in the collection

Items ()

Returns a table of Geometry items.

Return

UnsupportedType(List of Geometry): The list of items in the collection

MoveOut (geometry List of Object)

Moves the specified geometry parts out of this geometry group.

Input Parameters

geometry(List of Object): The geometry part to remove from the group.

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.

UniqueName (label string)

Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.