GroupOf_Mesh

Inheritance

The GroupOf_Mesh object is derived from the CollectionOf_Mesh object.

Usage locations

The GroupOf_Mesh 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)
Count
The number of Mesh items in the collection. (Read only number)
Label
The object label. (Read/Write string)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Property List (internal only)

Included
(Read/Write boolean)
IsExcluded
(Read only boolean)
IsLocked
(Read only boolean)
IsVisible
(Read only boolean)
LocalCoordSystemRotationAnglesInDegrees
(Read only Point)
Locked
(Read/Write boolean)
Path
(Read only string)
Tolerance
(Read only number)

Collection List

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

Collection List (internal only)

Groups
(GroupCollectionOf_Mesh of GroupOf_Mesh.)

Method List

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.
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 Mesh for the given index in the collection. (Returns a Mesh object.)
Item (label string)
Returns the Mesh for the given label in the collection. (Returns a Mesh object.)
Items ()
Returns a table of Mesh items. (Returns a UnsupportedType(List of Mesh) 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.

Method List (internal only)

CreateGroup ()
(Returns a Object object.)
DeleteEntities ( List of Object)
Disassemble ()
DuplicateEntities ( List of Object)
(Returns a List of Object object.)
MoveIn ( List of Object)
MoveOut ( List of Object)
Replace ( Mesh, Mesh)
ToggleVisibility ()

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 Mesh items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
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

Property Details (internal only)

Included
Type
boolean
Access
Read/Write
IsExcluded
Type
boolean
Access
Read only
IsLocked
Type
boolean
Access
Read only
IsVisible
Type
boolean
Access
Read only
LocalCoordSystemRotationAnglesInDegrees
Type
Point
Access
Read only
Locked
Type
boolean
Access
Read/Write
Path
Type
string
Access
Read only
Tolerance
Type
number
Access
Read only

Collection Details

Transforms
The collection of transforms on the operator.
Type
TransformCollection

Collection Details (internal only)

Groups
Type
GroupCollectionOf_Mesh

Method Details

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.
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 Mesh for the given index in the collection.
Input Parameters
index(number)
The index of the Mesh.
Return
Mesh
The item in the collection
Item (label string)
Returns the Mesh for the given label in the collection.
Input Parameters
label(string)
The label of the Mesh.
Return
Mesh
The item in the collection
Items ()
Returns a table of Mesh items.
Return
UnsupportedType(List of Mesh)
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.

Method Details (internal only)

CreateGroup ()
Return
Object
DeleteEntities ( List of Object)
Input Parameters
(List of Object)
Disassemble ()
DuplicateEntities ( List of Object)
Input Parameters
(List of Object)
Return
List of Object
MoveIn ( List of Object)
Input Parameters
(List of Object)
MoveOut ( List of Object)
Input Parameters
(List of Object)
Replace ( Mesh, Mesh)
Input Parameters
(Mesh)
(Mesh)
ToggleVisibility ()

Static Function Details

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