TopologyEntity
An abstract (base) object for elements with topology information.
Example
-- This is an abstract object, see derived objects for examples
Inheritance
The TopologyEntity object is derived from the Object object.
The following objects are derived (specialisations) from the TopologyEntity object:
Property List
- Faulty
- Indicates whether the geometry entity has faults. (Read only boolean)
- Geometry
- The geometry operator that the region belongs to. (Read only Geometry)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the geometry must be shown or hidden. (Read/Write boolean)
Method List
- 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
- Faulty
- Indicates whether the geometry entity has faults.
- Type
- boolean
- Access
- Read only
- Geometry
- The geometry operator that the region belongs to.
- Type
- Geometry
- Access
- Read only
- Label
- The object label.
- Type
- string
- 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
Method Details
- 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.