GeometryGroupCollection
A collection of geometry groups.
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 GeometryGroupCollection object is derived from the Object object.
Usage locations
The GeometryGroupCollection object can be accessed from the following locations:
- Collection lists
Property List
Method List
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 GeometryGroup for the given index in the collection. (Returns a GeometryGroup object.)
- Item (label string)
- Returns the GeometryGroup for the given label in the collection. (Returns a GeometryGroup object.)
- Items ()
- Returns a table of GeometryGroup items. (Returns a UnsupportedType(List of GeometryGroup) 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
Method Details
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 GeometryGroup for the given index in the collection.
- Input Parameters
- index(number)
- The index of the GeometryGroup.
- Return
- GeometryGroup
- The item in the collection
- Item (label string)
- Returns the GeometryGroup for the given label in the collection.
- Input Parameters
- label(string)
- The label of the GeometryGroup.
- Return
- GeometryGroup
- The item in the collection
- Items ()
- Returns a table of GeometryGroup items.
- Return
- UnsupportedType(List of GeometryGroup)
- The list of items in the collection
- 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.