Class ScrollArea

Defines the scroll area, a box collider that the user can interact with using an Interactor. The dragging events are exposed to be consumed in ScrollView

Hierarchy (View Summary)

View
- ScrollArea

Constructors

constructor

new ScrollArea(
    __namedParameters: {
        debugDrawEnabled: boolean;
        parentSceneObject: SceneObject;
        scrollAreaBounds: vec2;
    },
): ScrollArea
Parameters
- __namedParameters: {
      debugDrawEnabled: boolean;
      parentSceneObject: SceneObject;
      scrollAreaBounds: vec2;
  }
Returns ScrollArea
Overrides View.constructor

Properties

`Protected`_alpha

_alpha: number = 1

`Protected`attachedToScene

attachedToScene: boolean = false

`Protected`childViews

childViews: View<any>[] = []

`Protected`container

container: SceneObject

isDestroyed

isDestroyed: boolean = false

`Static`onCreateView

onCreateView: PublicApi<View<any>> = ...

`Static`onDestroyView

onDestroyView: PublicApi<View<any>> = ...

onEnabled

onEnabled: PublicApi<boolean> = ...

`Readonly`onFocusEnter

onFocusEnter: PublicApi<ScrollViewFocusEventArgs> = ...

`Readonly`onFocusExit

onFocusExit: PublicApi<ScrollViewFocusEventArgs> = ...

`Readonly`onTriggerCanceled

onTriggerCanceled: PublicApi<InteractorEvent>

`Readonly`onTriggerEnd

onTriggerEnd: PublicApi<InteractorEvent>

`Readonly`onTriggerStart

onTriggerStart: PublicApi<InteractorEvent>

Accessors

alpha

get alpha(): number
Returns the current alpha of the view

Returns number
Inherited from View.alpha
set alpha(a: number): void
Parameters
- a: number
Returns void
Inherit Doc
Inherited from View.alpha

boundariesProvider

get boundariesProvider(): ScreenTransformBoundariesProvider
Returns ScreenTransformBoundariesProvider

`Protected`config

get config(): Config
Returns Config
Inherited from View.config

debugDrawEnabled

get debugDrawEnabled(): boolean
Returns boolean
if collider wire is visible or not
set debugDrawEnabled(debugDrawEnabled: boolean): void
Toggles collider wire rendering for visualizing collider geometry shape and where it is placed.
Parameters
- debugDrawEnabled: boolean
Returns void

isDragging

get isDragging(): boolean
Returns boolean

localPosition

get localPosition(): vec3
Returns vec3
Inherited from View.localPosition
set localPosition(position: vec3): void
Parameters
- position: vec3
Returns void
Inherited from View.localPosition

localRotation

get localRotation(): quat
Returns quat
Inherited from View.localRotation
set localRotation(rotation: quat): void
Parameters
- rotation: quat
Returns void
Inherited from View.localRotation

localScale

get localScale(): number
Return the local scale of an object, assuming uniform scaling

Returns number
Inherited from View.localScale
set localScale(scale: number): void
Parameters
- scale: number
Returns void
Inherited from View.localScale

localScaleVec3

get localScaleVec3(): vec3
Returns vec3
Inherited from View.localScaleVec3
set localScaleVec3(vec: vec3): void
Parameters
- vec: vec3
Returns void
Inherited from View.localScaleVec3

name

get name(): string
Returns string
Inherited from View.name

position

get position(): vec3
Returns vec3
Deprecated
use localPosition instead

Inherited from View.position
set position(position: vec3): void
Parameters
- position: vec3
Returns void
Deprecated
pleasre use localPosition

Inherited from View.position

scale

set scale(scale: number): void
Parameters
- scale: number
Returns void
Deprecated
use localScale instead

Inherited from View.scale

scrollColliderBounds

get scrollColliderBounds(): vec2
Returns vec2
the collider's BoxShape's bounds.
set scrollColliderBounds(scrollColliderBounds: vec2): void
Parameters
- scrollColliderBounds: vec2
  the collider's BoxShape's bounds.
Returns void

worldPosition

get worldPosition(): vec3
Returns vec3
Inherited from View.worldPosition
set worldPosition(position: vec3): void
Parameters
- position: vec3
Returns void
Inherited from View.worldPosition

worldRotation

get worldRotation(): quat
Returns quat
Inherited from View.worldRotation
set worldRotation(rotation: quat): void
Parameters
- rotation: quat
Returns void
Inherited from View.worldRotation

worldScale

get worldScale(): number
Returns number
Inherited from View.worldScale
set worldScale(scale: number): void
Parameters
- scale: number
Returns void
Inherited from View.worldScale

worldScaleVec3

get worldScaleVec3(): vec3
Returns vec3
Inherited from View.worldScaleVec3
set worldScaleVec3(scale: vec3): void
Parameters
- scale: vec3
Returns void
Inherited from View.worldScaleVec3

Methods

`Protected`addChild

addChild<Child extends View<any>>(
    child: Child,
    configure?: (c: Child) => void,
    preserveWorldTransform?: boolean,
): Child
Type Parameters
- Child extends View<any>
Parameters
- child: Child
- Optionalconfigure: (c: Child) => void
- preserveWorldTransform: boolean = false
Returns Child
Inherited from View.addChild

addComponent

addComponent<K extends keyof ComponentNameMap>(typeName: K): ComponentNameMap[K]
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- typeName: K
Returns ComponentNameMap[K]
Inherited from View.addComponent

addOnDestroyCallback

addOnDestroyCallback(callback: OnDestroyCallback): void
addOnDestroyCallback adds a callback to call when the view is destroyed
Parameters
- callback: OnDestroyCallback
Returns void
Inherited from View.addOnDestroyCallback

attachToScene

attachToScene(parent: SceneObject): this
Parameters
- parent: SceneObject
Returns this
Inherited from View.attachToScene

destroy

destroy(): void
Returns void
Inherited from View.destroy

`Protected`destroyChild

destroyChild<Child extends View<any>>(child: Child): boolean
Destroys and removes the child from this View
Type Parameters
- Child extends View<any>
Parameters
- child: Child
  the child to be destroyed
Returns boolean
whether the child was destroyed

Inherited from View.destroyChild

`Protected`detachChild

detachChild<Child extends View<any>>(child: Child): boolean
Detaches child from parent and removes the child from this View
Type Parameters
- Child extends View<any>
Parameters
- child: Child
  the child to be detached
Returns boolean
whether the child was detached

Inherited from View.detachChild

getComponent

getComponent<K extends keyof ComponentNameMap>(typeName: K): ComponentNameMap[K]
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- typeName: K
Returns ComponentNameMap[K]
Inherited from View.getComponent

getRelativePosOfPoint

getRelativePosOfPoint(worldPos: vec3): vec3
Parameters
- worldPos: vec3
  a point representing something's world position
Returns vec3
the point's position relative to this view

Inherited from View.getRelativePosOfPoint

getSceneObject

getSceneObject(): SceneObject
Returns SceneObject
Inherited from View.getSceneObject

getTransform

getTransform(): Transform
Returns Transform
Inherited from View.getTransform

isEnabled

isEnabled(): boolean
Returns boolean
Inherited from View.isEnabled

isVisible

isVisible(): boolean
Returns boolean
Inherited from View.isVisible

`Protected`newChild

newChild<
    Conf,
    Child extends
        View<
            Conf extends Partial<
                {
                    defaults: Defaults;
                    enabled: boolean;
                    name: string;
                    position: vec3;
                    rotation: quat;
                    scale: number;
                },
            >
                ? Conf<Conf>
                : never,
        >,
>(
    ctor: new (conf: Conf) => Child,
    conf: Conf,
    customize?: (c: Child) => void,
): Child
Type Parameters
- Conf
- Child extends View<
      Conf extends Partial<
          {
              defaults: Defaults;
              enabled: boolean;
              name: string;
              position: vec3;
              rotation: quat;
              scale: number;
          },
      >
          ? Conf<Conf>
          : never,
  >
Parameters
- ctor: new (conf: Conf) => Child
- conf: Conf
- Optionalcustomize: (c: Child) => void
Returns Child
Inherited from View.newChild

`Protected`onAttachToScene

onAttachToScene(
    _defaults: Defaults,
    _parentView: View<
        Partial<
            {
                defaults: Defaults;
                enabled: boolean;
                name: string;
                position: vec3;
                rotation: quat;
                scale: number;
            },
        >,
    >,
): void
Parameters
- _defaults: Defaults
- _parentView: View<
      Partial<
          {
              defaults: Defaults;
              enabled: boolean;
              name: string;
              position: vec3;
              rotation: quat;
              scale: number;
          },
      >,
  >
Returns void
Inherited from View.onAttachToScene

`Protected`recursivelySetChildProperty

recursivelySetChildProperty<
    FieldName extends keyof ScrollArea,
    FieldType extends

            | string
            | number
            | boolean
            | vec3
            | quat
            | vec2
            | PublicApi<InteractorEvent>
            | PublicApi<DragInteractorEvent>
            | PublicApi<boolean>
            | (() => boolean)
            | (() => boolean)
            | ScreenTransformBoundariesProvider
            | PublicApi<ScrollViewFocusEventArgs>
            | (() => void)
            | (() => SceneObject)
            | ((a: number) => void)
            | ((callback: OnDestroyCallback) => void)
            | ((parent: SceneObject) => this)
            | (() => Transform)
            | ((worldPos: vec3) => vec3)
            | ((enabled: boolean) => void)
            | (
                <K extends keyof ComponentNameMap>(
                    typeName: K,
                ) => ComponentNameMap[K]
            )
            | (
                <K extends keyof ComponentNameMap>(
                    typeName: K,
                ) => ComponentNameMap[K]
            ),
>(
    fieldName: FieldName,
    newValue: FieldType,
): void
Type Parameters
- FieldName extends keyof ScrollArea
- FieldType extends
      | string
      | number
      | boolean
      | vec3
      | quat
      | vec2
      | PublicApi<InteractorEvent>
      | PublicApi<DragInteractorEvent>
      | PublicApi<boolean>
      | (() => boolean)
      | (() => boolean)
      | ScreenTransformBoundariesProvider
      | PublicApi<ScrollViewFocusEventArgs>
      | (() => void)
      | (() => SceneObject)
      | ((a: number) => void)
      | ((callback: OnDestroyCallback) => void)
      | ((parent: SceneObject) => this)
      | (() => Transform)
      | ((worldPos: vec3) => vec3)
      | ((enabled: boolean) => void)
      | (<K extends keyof ComponentNameMap>(typeName: K) => ComponentNameMap[K])
      | (<K extends keyof ComponentNameMap>(typeName: K) => ComponentNameMap[K])
Parameters
- fieldName: FieldName
- newValue: FieldType
Returns void
Inherited from View.recursivelySetChildProperty

`Protected`removeChild

removeChild<Child extends View<any>>(child: Child): void
Type Parameters
- Child extends View<any>
Parameters
- child: Child
Returns void
Deprecated
use destroyChild or detachChild instead.

Inherited from View.removeChild

setAlpha

setAlpha(a: number): void
Set the alpha of the View to a, and recursively apply this alpha to all descendents. The alpha will be applied by setting the .a component of baseColor to a.
Parameters
- a: number
  The value to set the alpha of the view to, from 0 to 1
Returns void
Inherited from View.setAlpha

setEnabled

setEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Inherited from View.setEnabled

Class ScrollArea

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScrollArea

Properties

Protected_alpha

ProtectedattachedToScene

ProtectedchildViews

Protectedcontainer

isDestroyed

StaticonCreateView

StaticonDestroyView

ReadonlyonDragEnd

ReadonlyonDragStart

ReadonlyonDragUpdate

onEnabled

ReadonlyonFocusEnter

ReadonlyonFocusExit

ReadonlyonTriggerCanceled

ReadonlyonTriggerEnd

ReadonlyonTriggerStart

Accessors

alpha

Returns number

Parameters

Returns void

Inherit Doc

boundariesProvider

Returns ScreenTransformBoundariesProvider

Protectedconfig

Returns Config

debugDrawEnabled

Returns boolean

Parameters

Returns void

isDragging

Returns boolean

localPosition

Returns vec3

Parameters

Returns void

localRotation

Returns quat

Parameters

Returns void

localScale

Returns number

Parameters

Returns void

localScaleVec3

Returns vec3

Parameters

Returns void

name

Returns string

position

Returns vec3

Deprecated

Parameters

Returns void

Deprecated

scale

Parameters

Returns void

Deprecated

scrollColliderBounds

Returns vec2

Parameters

Returns void

worldPosition

Returns vec3

Parameters

Returns void

`Protected`_alpha

`Protected`attachedToScene

`Protected`childViews

`Protected`container

`Static`onCreateView

`Static`onDestroyView

`Readonly`onDragEnd

`Readonly`onDragStart

`Readonly`onDragUpdate

`Readonly`onFocusEnter

`Readonly`onFocusExit

`Readonly`onTriggerCanceled

`Readonly`onTriggerEnd

`Readonly`onTriggerStart

`Protected`config

`Protected`addChild

`Protected`destroyChild

`Protected`detachChild

`Protected`newChild

`Protected`onAttachToScene

`Protected`recursivelySetChildProperty

`Protected`removeChild