`MockVoxelsModel`

Inheritance

The MockVoxelsModel object is derived from the Object object.

Property List

AbsoluteFilePath: The full path of the project file (directory path and file name including the file extension). (Read only string)
AbsolutePath: The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
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)

Property List (internal only)

Encrypted: (Read only boolean)
FDTDBoundary: (Read only FDTDBoundaryConditions)
FileName: (Read only string)
Media: (Read only Media)
Path: (Read only string)
Settings: (Read only VoxelSettings)
Tolerance: (Read only number)
UserAccessible: (Read only boolean)

Collection List (internal only)

Voxels: (MockVoxelMeshCollection of MockVoxelMesh.)

Method List

Delete (): Deletes the entity.
DeleteEntities (entities List of Object): Deletes the given list of entities. The entities may be in different collections.
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)

CreateExampleVoxelEdges (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelFaces (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelGrid (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelLargeEdges (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelLargeFaces (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelLargeRegions (): (Returns a MockVoxelMesh object.)
CreateExampleVoxelRegions (): (Returns a MockVoxelMesh object.)
StreamFromFile ( string)
StreamToFile ( string)
StreamToXmlFile ( string)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

AbsoluteFilePath

The full path of the project file (directory path and file name including the file extension).

Type: string
Access: Read only

AbsolutePath

The full directory path of the project file (directory path excluding the file name and extension).

Type: string
Access: Read only

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

Property Details (internal only)

Encrypted

Type: boolean
Access: Read only

FDTDBoundary

Type: FDTDBoundaryConditions
Access: Read only

FileName

Type: string
Access: Read only

Media

Type: Media
Access: Read only

Path

Type: string
Access: Read only

Settings

Type: VoxelSettings
Access: Read only

Tolerance

Type: number
Access: Read only

UserAccessible

Type: boolean
Access: Read only

Collection Details (internal only)

Voxels

Type: MockVoxelMeshCollection

Method Details

Delete ()

Deletes the entity.

DeleteEntities (entities List of Object)

Deletes the given list of entities. The entities may be in different collections.

Input Parameters

entities(List of Object): The list of entities to delete.

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