DeepAR Scripting API v5.6.15

Class: FacePositionComponent

FacePositionComponent

Face Position component.

Members

(readonly) assignedFaceId :uint

The assigned face ID. Assigned face ID can be 0 (first face), 1 (second face), 2 (third face) or 3 (fourth face).
Type:
  • uint

faceId :int

The face ID. Possible values are -1 (auto face), 0 (first face), 1 (second face), 2 (third face) and 3 (fourth face).
Type:
  • int

skipRotationX :bool

Ignore face rotation around the X-axis.
Type:
  • bool

skipRotationY :bool

Ignore face rotation around the Y-axis.
Type:
  • bool

skipRotationZ :bool

Ignore face rotation around the Z-axis.
Type:
  • bool

skipTranslationX :bool

Ignore face translation on the X-axis.
Type:
  • bool

skipTranslationY :bool

Ignore face translation on the Y-axis.
Type:
  • bool

skipTranslationZ :bool

Ignore face translation on the Z-axis.
Type:
  • bool

thresholdTranslation :Vector3

Value of the maximum absolute value allowed for X, Y and Z translation. Translations over the threshold are ignored. If threshold value is zero, no threshold is applied. Threshold translation values cannot be negative.
Type:

thresholdTranslationX :float

Value of the maximum absolute value allowed for X translation. Translations over the threshold are ignored. If threshold value is zero, no threshold is applied. Threshold translation X value cannot be negative.
Type:
  • float

thresholdTranslationY :float

Value of the maximum absolute value allowed for Y translation. Translations over the threshold are ignored. If threshold value is zero, no threshold is applied. Threshold translation Y value cannot be negative.
Type:
  • float

thresholdTranslationZ :float

Value of the maximum absolute value allowed for Z translation. Translations over the threshold are ignored. If threshold value is zero, no threshold is applied. Threshold translation Z value cannot be negative.
Type:
  • float

Methods

equals(facePositionComponent) → {bool}

Checks whether the Face Position component instances are same.
Parameters:
Name Type Description
facePositionComponent FacePositionComponent Face Position component instance.
Returns:
True if same, false otherwise.
Type
bool

toString() → {string}

Gets the string representation of the Face Position component.
Returns:
Face Position component string representation.
Type
string
Example
// Outputs '[Component FacePosition of Node "<node_name>"]' to the debug console.
Debug.log(facePositionComponent.toString());