FaceEntity

class Communicator.Selection.FaceEntity(): Encapsulates a face selection.

Methods

forJson()
getBounding()
getCadFaceBits()
getCadFaceIndex()
getNormal()
getPosition()
isCappingGeometry()
isProximityFace()
overlayIndex()
toJson()
construct()
fromJson()

Methods

forJson

Communicator.Selection.FaceEntity.forJson()

Note

forJson is deprecated: Use toJson instead.

Return type: Object

getBounding

Communicator.Selection.FaceEntity.getBounding()

Gets the bounding box for the face entity

Return type: Communicator.Box
Returns: Bounding box for the face entity

getCadFaceBits

Communicator.Selection.FaceEntity.getCadFaceBits()

Gets the cad face bits for the selection Point.

Return type: number
Returns: The bits set on the cad face.

getCadFaceIndex

Communicator.Selection.FaceEntity.getCadFaceIndex()

Gets the cad face index for the selection Point.

Return type: number
Returns: The index for the cad face.

getNormal

Communicator.Selection.FaceEntity.getNormal()

Gets the face normal for the selection Point.

Return type: Communicator.Point3
Returns: Face normal for the selection position if it can be determined.

getPosition

Communicator.Selection.FaceEntity.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.

isCappingGeometry

Communicator.Selection.FaceEntity.isCappingGeometry()

Returns whether or not this face entity is capping geometry or not.

Return type: boolean
Returns: True if this face entity is capping geometry and false otherwise.

isProximityFace

Communicator.Selection.FaceEntity.isProximityFace()

Returns whether or not this face entity was selected by proximity or was instead selected dead-on.

Return type: boolean
Returns: True if this face entity was selected by proximity and false otherwise.

overlayIndex

Communicator.Selection.FaceEntity.overlayIndex()

Return type: Communicator.OverlayIndex
Returns: The index of the overlay the entity belongs to.

toJson

Communicator.Selection.FaceEntity.toJson()

Creates an object ready for JSON serialization.

Return type: Object
Returns: The prepared object.

construct

Communicator.Selection.FaceEntity.construct(obj)

Note

construct is deprecated: Use fromJson instead.

Arguments

obj (any()) –

Return type

Communicator.Selection.FaceEntity

fromJson

Communicator.Selection.FaceEntity.fromJson(objData)

Creates a new FaceEntity from an object given by toJson

Arguments

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

Return type

Communicator.Selection.FaceEntity

Returns

The prepared object.