Class ContainerFrame

Base class for the ContainerFrame A 2D Container Component that can act as a "window" around your content

Hierarchy (view full)

BaseScriptComponent
- ContainerFrame

Index

Constructors

Accessors

backingAlpha borderAlpha localPosition localRotation localScale object opacity renderOrder totalInnerSize worldPosition worldRotation worldScale

Constructors

constructor

new ContainerFrame(): ContainerFrame
Returns ContainerFrame
Inherited from BaseScriptComponent.constructor

Properties

allowTranslation

allowTranslation: boolean = true

api

api: Record<string, any>

autoScaleContent

autoScaleContent: boolean = true

autoShowHide

autoShowHide: boolean = true

billboardComponent

billboardComponent: Billboard = null

border

border: number = 7

closeButton

closeButton: LabeledPinchButton

constantPadding

constantPadding: vec2 = ...

currentInteractor

currentInteractor: Interactor = null

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

followButton

followButton: LabeledPinchButton

event for callback on close button trigger

innerSize

innerSize: vec2

isFollowing

isFollowing: boolean = false

material

material: Material

name

name: string

onHoverEnterInnerInteractable

onHoverEnterInnerInteractable: PublicApi<void> = ...

onHoverExitInnerInteractable

onHoverExitInnerInteractable: PublicApi<void> = ...

onScalingEnd

onScalingEnd: default<void> = ...

event handler for frame scaling ended

onScalingEndEvent

onScalingEndEvent: PublicApi<void> = ...

public api for adding functions to the onScalingEnd event handler

onScalingStart

onScalingStart: default<void> = ...

event handler for frame scaling started

onScalingStartEvent

onScalingStartEvent: PublicApi<void> = ...

public api for adding functions to the onScalingStart event handler

onScalingUpdateEvent

onScalingUpdateEvent: PublicApi<void> = ...

public api for adding functions to the onScalingUpdate event handler

onSnappingComplete

onSnappingComplete: PublicApi<void> = null

public api for adding functions to the onSnappingComplete event handler

onTranslationEnd

onTranslationEnd: PublicApi<void> = ...

public api for adding functions to the onTranslationEndEvent event handler

onTranslationStart

onTranslationStart: PublicApi<void> = ...

public api for adding functions to the onTranslationStartEvent event handler

parentHoverBehavior

parentHoverBehavior: HoverBehavior

reference to HoverBehavior on parent element

parentTransform

parentTransform: Transform

`Readonly`sceneObject

sceneObject: SceneObject

smoothFollow

smoothFollow: SmoothFollow = null

reference to frame's default front follow behavior

`Readonly`uniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

worldCamera

worldCamera: Camera = ...

reference to world camera

Accessors

backingAlpha

get backingAlpha(): number
Returns number
alpha of the dark backing effect of the frame
set backingAlpha(alpha): void
Parameters
- alpha: number
  sets alpha of the dark backing effect of the frame
Returns void

borderAlpha

get borderAlpha(): number
Returns number
alpha of the glass border of the frame
set borderAlpha(alpha): void
Parameters
- alpha: number
  sets alpha of the glass border of the frame
Returns void

localPosition

get localPosition(): vec3
Returns vec3
current local position of frame
set localPosition(position): void
Parameters
- position: vec3
  sets current local position of frame
Returns void

localRotation

get localRotation(): quat
Returns quat
current local rotation of frame
set localRotation(rotation): void
Parameters
- rotation: quat
  set current local rotation of frame
Returns void

localScale

get localScale(): vec3
Returns vec3
current world scale of frame
set localScale(scale): void
Parameters
- scale: vec3
  set current local scale of frame
Returns void

object

get object(): SceneObject
Returns SceneObject
ContainerFrame frame sceneObject

opacity

get opacity(): number
Returns number
current opacity of frame elements
set opacity(opacity): void
Parameters
- opacity: number
  sets opacity for all frame elements note this parameter is effected by calls to showVisual and hideVisual
Returns void

renderOrder

get renderOrder(): number
Returns number
current renderOrder for the renderMeshVisual of the frame itself
set renderOrder(renderOrder): void
Parameters
- renderOrder: number
  sets renderOrder for the renderMeshVisual of the frame itself
Returns void

totalInnerSize

get totalInnerSize(): vec2
Returns vec2
vec2 of the total size of the container, including constant padding

worldPosition

get worldPosition(): vec3
Returns vec3
current world position of frame
set worldPosition(position): void
Parameters
- position: vec3
  sets current world position of frame
Returns void

worldRotation

get worldRotation(): quat
Returns quat
current world rotation of frame
set worldRotation(rotation): void
Parameters
- rotation: quat
  sets current local position of frame
Returns void

worldScale

get worldScale(): vec3
Returns vec3
current world scale of frame
set worldScale(scale): void
Parameters
- scale: vec3
  set current world scale of frame
Returns void

Methods

abortSnapping

abortSnapping(): void
abort snapping behavior

Returns void

createEvent

createEvent<K>(eventType): EventNameMap[K]
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Type Parameters
- K extends keyof EventNameMap
Parameters
- eventType: K
Returns EventNameMap[K]
Inherited from BaseScriptComponent.createEvent

destroy

destroy(): void
function for fully destroying the frame

Returns void
Overrides BaseScriptComponent.destroy

enableCloseButton

enableCloseButton(enabled): void
Parameters
- enabled: boolean
  set close button enabled or disabled
Returns void

enableFollowButton

enableFollowButton(enabled): void
Parameters
- enabled: boolean
  set follow button enabled or disabled
Returns void

enableInteractables

enableInteractables(isInteractable): void
Parameters
- isInteractable: boolean
  enable or disable interactable elements of the frame
Returns void

getFrameObject

getFrameObject(): SceneObject
Returns SceneObject
returns the frame sceneobject

getInteractable

getInteractable(): Interactable
Returns Interactable
frame's Interactable

getInteractableManipulation

getInteractableManipulation(): InteractableManipulation
Returns InteractableManipulation
frame's InteractableManipulation

getLocalPosition

getLocalPosition(): vec3
Returns vec3
current local position of frame

getLocalRotation

getLocalRotation(): quat
Returns quat
current local rotation of frame

getParentInteractable

getParentInteractable(): Interactable
Returns Interactable
frame's parent's Interactable

getParentTransform

getParentTransform(): Transform
Returns Transform
parent transform of top container object

getReferencedEvents

getReferencedEvents(): SceneEvent[]
Returns SceneEvent[]
Inherited from BaseScriptComponent.getReferencedEvents

getSceneObject

getSceneObject(): SceneObject
Returns the SceneObject the component is attached to.

Returns SceneObject
Inherited from BaseScriptComponent.getSceneObject

getTargetObject

getTargetObject(): SceneObject
Returns SceneObject
inner object which contains original children

getTransform

getTransform(): Transform
Returns the Transform this component is attached to.

Returns Transform
Inherited from BaseScriptComponent.getTransform

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from BaseScriptComponent.getTypeName

getWorldPosition

getWorldPosition(): vec3
Gets current world position of frame

Returns vec3

getWorldRotation

getWorldRotation(): quat
Returns quat
current world rotation of frame

hideVisual

hideVisual(): void
tween to hide visuals of frame and elementss

Returns void

isOfType

isOfType(type): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from BaseScriptComponent.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
- other: ScriptObject
Returns boolean
Inherited from BaseScriptComponent.isSame

isSnappingActive

isSnappingActive(): boolean
Returns boolean
whether the snapping behavior is checking for snappable elements

isSnappingTweening

isSnappingTweening(): boolean
Returns boolean
whether the snapping behavior is currently tweening

onAwake

onAwake(): void
Returns void

removeEvent

removeEvent(event): void
Removes a previously added SceneEvent from the ScriptComponent.
Parameters
- event: SceneEvent
Returns void
Inherited from BaseScriptComponent.removeEvent

setAllowScaling

setAllowScaling(allowScaling): void
Parameters
- allowScaling: boolean
  enable or disable user scaling
Returns void

setBillboarding

setBillboarding(useBillboard, xOnTranslate?, xAlways?, yOnTranslate?, yAlways?): void
setup billboarding component with the following parameters
Parameters
- useBillboard: boolean
- xOnTranslate: boolean = false
- xAlways: boolean = false
- yOnTranslate: boolean = false
- yAlways: boolean = false
Returns void

setButtonScale

setButtonScale(size): void
set diameter of buttons in centimeters
Parameters
- size: number
Returns void

setHoverInteractableOpacity

setHoverInteractableOpacity(opacity): void
Parameters
- opacity: number
  sets opacity of frame when hovering interactable content in the frame
Returns void

setInnerSizePreserveScale

setInnerSizePreserveScale(newSize): void
Parameters
- newSize: vec2
Returns void

setIsContentInteractable

setIsContentInteractable(isInteractable): void
Parameters
- isInteractable: boolean
  set if content is interactable
Returns void

setIsFollowing

setIsFollowing(isFollowing): void
Parameters
- isFollowing: boolean
  enable or disable the following button and defualt behavior ( if it is enabled )
Returns void

setIsSnappable

setIsSnappable(isSnappable): void
Parameters
- isSnappable: boolean
  turns on or off snappableBehavior
Returns void

setLocalPosition

setLocalPosition(position): void
Parameters
- position: vec3
  sets current local position of frame
Returns void

setLocalRotation

setLocalRotation(rotation): void
Parameters
- rotation: quat
  set current local rotation of frame
Returns void

setmaximumSize

setmaximumSize(maximumSize): void
Parameters
- maximumSize: vec2
  set maximum scale of frame
Returns void

setminimumSize

setminimumSize(minimumSize): void
Parameters
- minimumSize: vec2
  set minimum scale of frame
Returns void

setSnappingActive

setSnappingActive(isActive): void
Parameters
- isActive: boolean
  whether or not to activate snapping
Returns void

setUseBillboarding

setUseBillboarding(useBillboarding): void
Parameters
- useBillboarding: boolean
Returns void

setUseFollow

setUseFollow(useFollow): void
Parameters
- useFollow: boolean
  enable or disable the option to turn on the default follow behavior with the follow button
Returns void

setUseItemSnapping

setUseItemSnapping(enable): void
Parameters
- enable: boolean
Returns void

setUseWorldSnapping

setUseWorldSnapping(enable): void
Parameters
- enable: boolean
Returns void

setWorldPosition

setWorldPosition(position): void
Parameters
- position: vec3
  sets current world position of frame
Returns void

setWorldRotation

setWorldRotation(rotation): void
Parameters
- rotation: quat
  sets current local position of frame
Returns void

setYAlways

setYAlways(yAlways): void
Parameters
- yAlways: boolean
Returns void

showVisual

showVisual(): void
tween to show visuals of frame and elements

Returns void

tweenOpacity

tweenOpacity(currentOpacity, targetOpacity, endCallback?): void
tween from current opacity to target opacity, will cancel existing opacity tweens
Parameters
- currentOpacity: number
- targetOpacity: number
- endCallback: (() => void) = ...
  - - (): void
    - Returns void
Returns void

`Static`getTypeName

getTypeName<T>(this): TypeName<InstanceType<T>>
Type Parameters
- T extends typeof BaseScriptComponent
Parameters
- this: T
Returns TypeName<InstanceType<T>>
Inherited from BaseScriptComponent.getTypeName

Class ContainerFrame

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ContainerFrame

Properties

allowTranslation

api

autoScaleContent

autoShowHide

billboardComponent

border

closeButton

constantPadding

currentInteractor

enabled

followButton

innerSize

isFollowing

material

name

onHoverEnterInnerInteractable

onHoverExitInnerInteractable

onScalingEnd

onScalingEndEvent

onScalingStart

onScalingStartEvent

onScalingUpdateEvent

onSnappingComplete

onTranslationEnd

onTranslationStart

parentHoverBehavior

parentTransform

ReadonlysceneObject

smoothFollow

ReadonlyuniqueIdentifier

updatePriority

worldCamera

Accessors

backingAlpha

Returns number

Parameters

Returns void

borderAlpha

Returns number

Parameters

Returns void

localPosition

Returns vec3

Parameters

Returns void

localRotation

Returns quat

Parameters

Returns void

localScale

Returns vec3

Parameters

Returns void

object

Returns SceneObject

opacity

Returns number

Parameters

Returns void

renderOrder

Returns number

Parameters

Returns void

totalInnerSize

Returns vec2

worldPosition

Returns vec3

Parameters

Returns void

`Readonly`sceneObject

`Readonly`uniqueIdentifier