`SnapSettings`

Inheritance

The SnapSettings object is derived from the Object object.

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

FixedGridSize: (Read/Write number)
Geometry: (Read/Write boolean)
GeometrySurfacesAndWires: (Read/Write boolean)
GridOptions: (Read/Write PlaneGridEnum)
Mesh: (Read/Write boolean)
NamedPoints: (Read/Write boolean)
Path: (Read only string)
SnapOffset: (Read/Write 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.

Static Function List

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

Property Details

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

FixedGridSize

Type: number
Access: Read/Write

Geometry

Type: boolean
Access: Read/Write

GeometrySurfacesAndWires

Type: boolean
Access: Read/Write

GridOptions

Type: PlaneGridEnum
Access: Read/Write

Mesh

Type: boolean
Access: Read/Write

NamedPoints

Type: boolean
Access: Read/Write

Path

Type: string
Access: Read only

SnapOffset

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