Options
All
  • Public
  • Public/Protected
  • All
Menu

Class A2DParticlesModel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _eventCallbackDicts

_eventCallbackDicts: {} = {}

Type declaration

Protected _material

_material: AMaterial

Protected _maxNumParticles

_maxNumParticles: number

Protected _parent

_parent: null | AObjectNode

Protected _subscriptions

_subscriptions: {} = {}

Type declaration

_transform

_transform: NodeTransform3D

children

children: AObjectNode[]

clock

clock: AClock

color

color: Color

geometry

geometry: GeometrySet

nParticles

nParticles: number

name

name: string

Abstract particles

particles: AParticle[]

playing

playing: boolean

selectable

selectable: boolean

state

state: {} = {}

Type declaration

  • [name: string]: any

time

time: number

uid

uid: string

Static AObjectStateKeys

AObjectStateKeys: string[] = []

Static AObjectVersion

AObjectVersion: number = 1

Static Events

Events: typeof AModelEvents = ...

Static NodeEvents

NodeEvents: typeof SceneNodeEvents = ...

Static SupportsUploadedModels

SupportsUploadedModels: boolean = false

Accessors

ClassConstructor

  • get ClassConstructor(): typeof AObject

material

maxNumParticles

  • get maxNumParticles(): number

parent

paused

  • get paused(): boolean
  • set paused(v: boolean): void

rate

  • get rate(): number
  • set rate(value: number): void

serializationLabel

  • get serializationLabel(): any

stateSnapshop

  • get stateSnapshop(): {}

transform

verts

Methods

_attachToNewParent

_childrenListToUIDs

  • _childrenListToUIDs(childrenList: AObjectNode[]): string[]

_disposeMaterial

  • _disposeMaterial(): void

_getEventCallbackDict

_getListeners

  • _getListeners(): {}

_removeChild

  • _removeChild(child: AObjectNode, triggerNewParentEvent?: boolean): void

_removeFromParent

  • _removeFromParent(triggerNewParentEvent?: boolean): void

_uidsToChildrenList

activateSubscription

  • activateSubscription(name: string): void

addChild

addColorListener

  • addColorListener(callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

addEnterSelectionListener

  • addEnterSelectionListener(callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addEventListener

  • addEventListener(eventName: string, callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addEventListeners

  • addEventListeners(eventName: string, callbacks: ((...args: any[]) => void)[], handle?: string): AEventCallbackSwitch

addExitSelectionListener

addGeometryListener

  • addGeometryListener(callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

addMaterialChangeListener

  • addMaterialChangeListener(callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addMaterialUpdateListener

  • addMaterialUpdateListener(callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addOneTimeEventListener

  • addOneTimeEventListener(eventName: string, callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addStateKeyListener

  • addStateKeyListener(state_key: string, callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

  • Sets a callback function to be called whenever the state specified in state_key changes. The return value callbackSwitch is a callback switch. You can activate the listener with callbackSwitch.activate() and deactive with callbackSwitch.deactivate(). Example Usage:

    var callbackswitch = model.addStateKeyListener('name',()=>{
         n_name_changes = n_name_changes+1;
    })

    Parameters

    • state_key: string

      the name of the state to listen to

    • callback: (self: AObject) => void

      the callback to be executed when state changes

    • Optional handle: string

      the handle / unique identifier for

    • synchronous: boolean = true

      whether callbacks should happen synchronously or allow for batching

    Returns AStateCallbackSwitch

addStateListener

  • addStateListener(callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

addTransformListener

  • addTransformListener(callback: (self: AObject) => void, handle?: string, synchronous?: boolean): ACallbackSwitch

clearSubscriptions

  • clearSubscriptions(): void

deactivateSubscription

  • deactivateSubscription(name: string): void

dispose

  • dispose(): void

filterChildren

filterDescendants

getBounds

getCameraNodes

  • getCameraNodes(): void

getChildWithID

getDescendantList

getModelGUIControlSpec

  • getModelGUIControlSpec(): { nParticles: { max: number; min: number; onChange: (v: number) => void; step: number; value: number } }

  • Returns { nParticles: { max: number; min: number; onChange: (v: number) => void; step: number; value: number } }

    • nParticles: { max: number; min: number; onChange: (v: number) => void; step: number; value: number }
      • max: number
      • min: number
      • onChange: (v: number) => void
          • (v: number): void

          • Parameters

            • v: number

            Returns void

      • step: number
      • value: number

getSceneModel

getWorldPosition

  • getWorldPosition(): Vec3

getWorldTransform

mapOverChildren

  • mapOverChildren(fn: (child: AObjectNode) => void | any[]): (void | any[])[]

mapOverDescendants

  • mapOverDescendants(fn: (child: AObjectNode) => void | any[]): (void | any[])[]

onMaterialUpdate

  • onMaterialUpdate(...args: any[]): void

pause

  • pause(): void

play

  • play(): void

recenterAnchor

  • recenterAnchor(): void

release

  • release(...args: any[]): void

releaseChildren

  • releaseChildren(...args: any[]): (void | any[])[]

removeChild

removeChildren

  • removeChildren(): (void | any[])[]

removeEventListener

  • removeEventListener(eventName: string, handle: string): void

removeListener

  • removeListener(handle: string): void

reorderChildren

  • reorderChildren(uidList: string[]): void

reparent

setMaterial

  • setMaterial(material: string | AMaterial): void

setMaterialUpdateSubscriptions

  • setMaterialUpdateSubscriptions(): void

setTransform

signalEvent

  • signalEvent(eventName: string, ...args: any[]): void

subscribe

toJSON

  • toJSON(): {}

unsubscribe

  • unsubscribe(name: string, errorIfAbsent?: boolean): void

Abstract update

  • update(t: number, ...args: any[]): void

Static CreateWithState

  • CreateWithState(state: {}): AObject

Static SerializationLabel

  • SerializationLabel(): any

Static fromJSON

Generated using TypeDoc