FaceEntity
- class Communicator.Selection.FaceEntity()
Encapsulates a face selection.
Methods
Methods
forJson
- FaceEntity.forJson()
- Deprecated
Use
toJson
instead.- Return type
Object
getBounding
getCadFaceBits
- FaceEntity.getCadFaceBits()
Gets the cad face bits for the selection Point.
- Return type
number
- Returns
The bits set on the cad face.
getCadFaceIndex
- FaceEntity.getCadFaceIndex()
Gets the cad face index for the selection Point.
- Return type
number
- Returns
The index for the cad face.
getNormal
getPosition
isCappingGeometry
- 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
- 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
- FaceEntity.overlayIndex()
- Return type
- Returns
The index of the overlay the entity belongs to.
toJson
- FaceEntity.toJson()
Creates an object ready for JSON serialization.
- Return type
Object
- Returns
The prepared object.
static construct
- FaceEntity.construct(obj)
- Deprecated
Use
fromJson
instead.- Arguments
obj (
any()
) –
- Return type
static fromJson
- FaceEntity.fromJson(objData)
Creates a new
FaceEntity
from an object given bytoJson
- Arguments
objData (
any()
) – An object given bytoJson
- Return type
- Returns
The prepared object.