Skip to main content

PointCloud

Class

Represents 3D locations of stationary features in the environment.

  • 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.

Represents 3D locations of stationary features in the environment. The resulting cloud of points provides a sparse description of the 3D environment.

Index

Example

// Enable point clouds
script.tracking.worldOptions.pointCloudEnabled = true;

// .....
// Use point clouds
var positions = script.tracking.getPointCloud().positions;
var ids = script.tracking.getPointCloud().ids;
print("Number of points: " + positions.length);

Extends

Properties

confidences

readonly confidences: number[]

Experimental

The confidence level of the point cloud.


ids

readonly ids: number[]

A list of numeric identifiers for each unique 3D point in the cloud.


positions

readonly positions: vec3[]

A list of vec3 objects representing the 3D position of every point.

Methods

getTypeName()

static getTypeName(): TypeName<PointCloud>

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<PointCloud>

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