Skip to main content

TrackedMeshHitTestResult

Class

Provides information about a TrackedMesh surface hit during a raycast.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Provides information about a TrackedMesh surface hit during a raycast. Is returned in an array when calling DeviceTracking.hitTestWorldMesh() or DeviceTracking.raycastWorldMesh().

Index

Extends

Properties

classification

readonly classification: TrackedMeshFaceClassification

Returns the classification of the mesh face at the intersection point.


mesh

readonly mesh: TrackedMesh

Returns the TrackedMesh that was hit.


normal

readonly normal: vec3

Returns the world space normal direction of the intersection point.


position

readonly position: vec3

Returns the world space position of the intersection point.

Methods

getTypeName()

static getTypeName(): TypeName<TrackedMeshHitTestResult>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<TrackedMeshHitTestResult>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame