`MockVoxelMesh`

Inheritance

The MockVoxelMesh object is derived from the AbstractVoxelMesh object.

Usage locations

The MockVoxelMesh object can be accessed from the following locations:

Methods
- MockVoxelMeshCollection collection has method Item(number).
- MockVoxelMeshCollection collection has method Item(string).
- MockVoxelsModel object has method CreateExampleVoxelEdges().
- MockVoxelsModel object has method CreateExampleVoxelFaces().
- MockVoxelsModel object has method CreateExampleVoxelGrid().
- MockVoxelsModel object has method CreateExampleVoxelLargeEdges().
- MockVoxelsModel object has method CreateExampleVoxelLargeFaces().
- MockVoxelsModel object has method CreateExampleVoxelLargeRegions().
- MockVoxelsModel object has method CreateExampleVoxelRegions().

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)
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)

IsVisible: (Read only boolean)
Path: (Read only string)
Tolerance: (Read only number)

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.

Method List (internal only)

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

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

Property Details (internal only)

IsVisible

Type: boolean
Access: Read only

Path

Type: string
Access: Read only

Tolerance

Type: number
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.

Method Details (internal only)

ToggleVisibility ()

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.