MeshWire
An abstract (base) object for mesh segment wires.
Example
-- This is an abstract object, see derived objects for examples
Inheritance
The MeshWire object is derived from the AbstractMeshWire object.
The following objects are derived (specialisations) from the MeshWire object:
Usage locations
The MeshWire object can be accessed from the following locations:
- Methods
- MeshSegmentWireCollection collection has method Item(number).
- MeshSegmentWireCollection collection has method Item(string).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Label
- The object label. (Read/Write string)
- Part
- The mesh part that this entity belongs to. (Read only Mesh)
- 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.
- SetRadiusOnAllSegments (radius Expression)
- Set the segment radius. This is a helper method to update the Radius property on all the segments simultaneously.
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
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Part
- The mesh part that this entity belongs to.
- Type
- Mesh
- 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
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.
- SetRadiusOnAllSegments (radius Expression)
- Set the segment radius. This is a helper method to update the Radius property on all the segments simultaneously.
- Input Parameters
- radius(Expression)
- The new radius.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.