Class ManipulateComponent

Handles input information from user touch input via the InteractionComponent to control the Scale, Rotation, and Translation of objects.

Example

// Disables the scale functionality on a manipulate component when a user taps
//@input Component.ManipulateComponent manip

function onTap(eventData)
{
    script.manip.enableManipulateType(ManipulateType.Scale, false);
}
var tapEvent = script.createEvent("TapEvent");
tapEvent.bind(onTap);

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled isContextualSwivel isManipulating maxDistance maxHeight maxScale minDistance minHeight minScale onManipulateEnd onManipulateStart rotationScale sceneObject uniqueIdentifier

Methods

clampWorldPosition destroy enableManipulateType getSceneObject getTransform getTypeName intersectManipulateFrame isManipulateTypeEnabled isOfType isSame

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

isContextualSwivel

isContextualSwivel: boolean

Changes swivel behavior based on the object's height relative to the camera.

ReadonlyisManipulating

isManipulating: boolean

Returns whether the object that the Manipulate Component is on is currently being manipulated

maxDistance

maxDistance: number

The maximum distance the object can travel from the user.

maxHeight

maxHeight: number

The maximum height of the object.

maxScale

maxScale: number

The maximum size the object can scale to.

minDistance

minDistance: number

The minimum distance the object can be from the user.

minHeight

minHeight: number

The minimum height of the object.

minScale

minScale: number

The minimum size the object can shrink to.

ReadonlyonManipulateEnd

onManipulateEnd: event1<ManipulateEndEventArgs, void>

Event fired when manipulation ends.

ReadonlyonManipulateStart

onManipulateStart: event1<ManipulateStartEventArgs, void>

Event fired when manipulation starts.

rotationScale

rotationScale: number

Multiplier for swivel rotation speed. For example, a value of 0.5 will cut rotation speed in half, and a value of 2.0 will double rotation speed.

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

clampWorldPosition

  • clampWorldPosition(): void

    Repositions the object to be within the bounds of minDistance, maxDistance.

    Returns void

destroy

  • destroy(): void

    Destroys the component.

    Returns void

enableManipulateType

  • enableManipulateType(type: ManipulateType, enable: boolean): void

    Enables or disables the specified ManipulateType for this ManipulateComponent.

    Parameters

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

intersectManipulateFrame

  • intersectManipulateFrame(screenSpacePoint: vec2): ManipulateFrameIntersectResult

    Checks for an intersection point between the manipulation plane and a line extending from the camera through the specified screen space point. The screen point is passed in as (x, y) with both values ranging from ([0-1], [0-1]), (0,0) being left-top and (1,1) being right-bottom. The result is returned as a ManipulateFrameIntersectResult object.

    Parameters

    • screenSpacePoint: vec2

    Returns ManipulateFrameIntersectResult

isManipulateTypeEnabled

  • isManipulateTypeEnabled(type: ManipulateType): boolean

    Returns whether the specified ManipulateType is enabled for this ManipulateComponent.

    Parameters

    Returns boolean

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

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

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR