PointEntity

class Communicator.Selection.PointEntity()

Methods

• forJson()

• getPointBits()

• getPointId()

• getPosition()

• overlayIndex()

• toJson()

• construct()

• fromJson()

---

Methods

forJson

Communicator.Selection.PointEntity.forJson()

Note

forJson is deprecated: Use toJson instead.

Return type

Object

getPointBits

Communicator.Selection.PointEntity.getPointBits()

Gets the cad bits for the selection Point.

Return type

number

Returns

The bits set on the point.

getPointId

Communicator.Selection.PointEntity.getPointId()

Gets the point identifier

Return type

number

Returns

the identifier of the point that was selected

getPosition

Communicator.Selection.PointEntity.getPosition()

Gets the world space position of the selection point.

Return type

Communicator.Point3

Returns

World space position of the selection point if it can be determined.

overlayIndex

Communicator.Selection.PointEntity.overlayIndex()

Return type

Communicator.OverlayIndex

Returns

The index of the overlay the entity belongs to.

toJson

Communicator.Selection.PointEntity.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.

construct

Communicator.Selection.PointEntity.construct(obj)

Note

construct is deprecated: Use fromJson instead.

Arguments

• obj (any()) –

Return type

Communicator.Selection.PointEntity

fromJson

Communicator.Selection.PointEntity.fromJson(objData)

Creates a new PointEntity from an object given by toJson

Arguments

• objData (any()) – An object given by toJson

Return type

Communicator.Selection.PointEntity

Returns

The prepared object.