Skip to main content

RotatedRect

Class

Class in the Lens Scripting API.

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

Since Lens Scripting v170

Index

Example

var rotatedRect = RotatedRect.create(center, size, angle);
var rectPoints = new Float32Array(8);
TensorMath.getRotatedRectPoints(rotatedRect, rectPoints);

Extends

Properties

angle

angle: number

The rotation angle in degrees.

Since

Lens Scripting Version 170

Default Value

0

center

center: vec2

The center point (mass center) of RotatedRect.

Since

Lens Scripting Version 170

Default Value

(0, 0)

size

size: vec2

The width and height of RotatedRect.

Since

Lens Scripting Version 170

Default Value

(0, 0)

Methods

create()

static create(center, size, angle): RotatedRect

Creates a RotatedRect object.

Parameters

ParameterType
centervec2
sizevec2
anglenumber

Returns

RotatedRect

Since

Lens Scripting Version 170


getTypeName()

static getTypeName(): TypeName<RotatedRect>

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

Since

Lens Scripting Version 170

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


toString()

toString(): string

Returns the description of RotatedRect.

Returns

string

Since

Lens Scripting Version 170