Class InteractableManipulation

Binds scripts to Events and executes them when triggered. Any script can access the ScriptComponent executing them through the variable script. See also: Scripting Overview, Script Events Guide.

Example

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
    print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);

Hierarchy (view full)

Constructors

constructor

Properties

api beta dcutoff enabled enableStretchZ maximumScaleFactor minCutoff minimumScaleFactor name onManipulationEnd onManipulationStart onManipulationUpdate onRotationEnd onRotationStart onRotationUpdate onScaleEnd onScaleLimitReached onScaleStart onScaleUpdate onTranslationEnd onTranslationStart onTranslationUpdate sceneObject showRotationProperties showStretchZProperties showTranslationProperties uniqueIdentifier updatePriority zStretchFactorMax zStretchFactorMin

Accessors

enableXTranslation enableYTranslation enableZTranslation rotationAxis

Methods

canRotate canScale canTranslate createEvent destroy getManipulateRoot getReferencedEvents getSceneObject getTransform getTypeName isOfType isSame onAwake removeEvent resetPosition resetRotation resetScale resetTransform setCanRotate setCanScale setCanTranslate setManipulateRoot getTypeName

Constructors

constructor

Properties

api

api: Record<string, any>

beta

beta: number = 0.015

dcutoff

dcutoff: number = 1

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

enableStretchZ

enableStretchZ: boolean = true

maximumScaleFactor

maximumScaleFactor: number = 20

minCutoff

minCutoff: number = 2

minimumScaleFactor

minimumScaleFactor: number = 0.25

name

name: string

onManipulationEnd

onManipulationEnd: PublicApi<TransformEventArg> = ...

Callback for when any manipulation ends

onManipulationStart

onManipulationStart: PublicApi<TransformEventArg> = ...

Callback for when any manipulation begins

onManipulationUpdate

onManipulationUpdate: PublicApi<TransformEventArg> = ...

Callback for when any manipulation updates

onRotationEnd

onRotationEnd: PublicApi<RotationEventArg> = ...

Callback for when rotation has ended

onRotationStart

onRotationStart: PublicApi<RotationEventArg> = ...

Callback for when rotation begins

onRotationUpdate

onRotationUpdate: PublicApi<RotationEventArg> = ...

Callback for when rotation updates each frame

onScaleEnd

onScaleEnd: PublicApi<ScaleEventArg> = ...

Callback for when scale has ended

onScaleLimitReached

onScaleLimitReached: PublicApi<ScaleLimitEventArg> = ...

Callback for when scale has reached the minimum or maximum limit

onScaleStart

onScaleStart: PublicApi<ScaleEventArg> = ...

Callback for when scale begins

onScaleUpdate

onScaleUpdate: PublicApi<ScaleEventArg> = ...

Callback for when scale updates each frame

onTranslationEnd

onTranslationEnd: PublicApi<TranslateEventArg> = ...

Callback for when translation has ended

onTranslationStart

onTranslationStart: PublicApi<TranslateEventArg> = ...

Callback for when translation begins

onTranslationUpdate

onTranslationUpdate: PublicApi<TranslateEventArg> = ...

Callback for when translation updates each frame

ReadonlysceneObject

sceneObject: SceneObject

showRotationProperties

showRotationProperties: boolean = false

showStretchZProperties

showStretchZProperties: boolean = false

showTranslationProperties

showTranslationProperties: boolean = false

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

zStretchFactorMax

zStretchFactorMax: number = 12.0

zStretchFactorMin

zStretchFactorMin: number = 1.0

Accessors

enableXTranslation

  • get enableXTranslation(): boolean

  • Returns if translation along world X-axis is enabled.

    Returns boolean

  • set enableXTranslation(enabled): void

  • Set if translation along world X-axis is enabled.

    Parameters

    • enabled: boolean

    Returns void

enableYTranslation

  • get enableYTranslation(): boolean

  • Returns if translation along world Y-axis is enabled.

    Returns boolean

  • set enableYTranslation(enabled): void

  • Set if translation along world Y-axis is enabled.

    Parameters

    • enabled: boolean

    Returns void

enableZTranslation

  • get enableZTranslation(): boolean

  • Returns if translation along world Z-axis is enabled.

    Returns boolean

  • set enableZTranslation(enabled): void

  • Set if translation along world Z-axis is enabled.

    Parameters

    • enabled: boolean

    Returns void

rotationAxis

  • get rotationAxis(): RotationAxis

  • Get if rotation occurs about all axes or a single world axis (x,y,z) when using to two hands..

    Returns RotationAxis

  • set rotationAxis(axis): void

  • Set if rotation occurs about all axes or a single world axis (x,y,z) when using to two hands.

    Parameters

    Returns void

Methods

canRotate

  • canRotate(): boolean

  • Returns true if any of rotation x, y, or z is enabled

    Returns boolean

canScale

  • canScale(): boolean

  • Returns true if any of scale x, y, or z is enabled

    Returns boolean

canTranslate

  • canTranslate(): boolean

  • Returns true translation is enabled

    Returns boolean

createEvent

destroy

getManipulateRoot

  • getManipulateRoot(): Transform

  • Gets the transform of the root of the manipulated object(s).

    Returns Transform

getReferencedEvents

getSceneObject

getTransform

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

onAwake

  • onAwake(): void

  • Returns void

removeEvent

resetPosition

  • resetPosition(local?): void

  • Resets the interactable's position

    Parameters

    • local: boolean = false

    Returns void

resetRotation

  • resetRotation(local?): void

  • Resets the interactable's rotation

    Parameters

    • local: boolean = false

    Returns void

resetScale

  • resetScale(local?): void

  • Resets the interactable's scale

    Parameters

    • local: boolean = false

    Returns void

resetTransform

  • resetTransform(local?): void

  • Resets the interactable's transform

    Parameters

    • local: boolean = false

    Returns void

setCanRotate

  • setCanRotate(enabled): void

  • Toggle for allowing an object to rotate

    Parameters

    • enabled: boolean

    Returns void

setCanScale

  • setCanScale(enabled): void

  • Toggle for allowing an object to scale

    Parameters

    • enabled: boolean

    Returns void

setCanTranslate

  • setCanTranslate(enabled): void

  • Toggle for allowing an object to translate

    Parameters

    • enabled: boolean

    Returns void

setManipulateRoot

  • setManipulateRoot(root): void

  • Sets the transform of the passed SceneObject as the root of the manipulated object(s).

    Parameters

    Returns void

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods