`AbstractMeshWire`

An abstract (base) object for mesh triangle wires.

Example

-- This is an abstract object, see derived objects for examples

Inheritance

The AbstractMeshWire object is derived from the MeshTopology object.

The following objects are derived (specialisations) from the AbstractMeshWire object:

Property List

AllowDifferentSegmentRadii: Allow modification of radii per segment. (Read/Write boolean)
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)

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

AllowDifferentSegmentRadii

Allow modification of radii per segment.

Type: boolean
Access: Read/Write

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

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.