Options
Menu

Class ParticleTimeNode

A particle animation node used as the base node for timekeeping inside a particle. Automatically added to a particle animation set on instatiation.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

constructor

  • new ParticleTimeNode(usesDuration?: boolean, usesLooping?: boolean, usesDelay?: boolean): ParticleTimeNode
  • Creates a new ParticleTimeNode

    Parameters

    • Default value usesDuration: boolean = false

      Defines whether the node uses the duration data in the static properties to determine how long a particle is visible for. Defaults to false.

    • Default value usesLooping: boolean = false

      Defines whether the node creates a looping timeframe for each particle determined by the startTime, duration and delay data in the static properties function. Defaults to false. Requires usesLooping to be true.

    • Default value usesDelay: boolean = false

      Defines whether the node uses the delay data in the static properties to determine how long a particle is hidden for. Defaults to false. Requires usesDuration to be true.

    Returns ParticleTimeNode

Properties

_adapter

_adapter: IAssetAdapter

_iDataOffset

_iDataOffset: number

Private _iUsesDelay

_iUsesDelay: boolean

Private _iUsesDuration

_iUsesDuration: boolean

Private _iUsesLooping

_iUsesLooping: boolean

_pDataLength

_pDataLength: number

_pMode

_pMode: number

_pOneData

_pOneData: Array<number>

_pStateClass

_pStateClass: any

adaptee

adaptee: AssetBase

adapter

adapter: IAssetAdapter

adapter is used to provide MovieClip to scripts taken from different platforms setter typically managed by factory. getter defaults to AwayJS class

assetFullPath

assetFullPath: Array<string>

assetNamespace

assetNamespace: string

assetType

assetType: string
inheritdoc

id

id: number

A unique id for the asset, used to identify assets in an associative array

name

name: string

originalName

originalName: string

The original name used for this asset in the resource (e.g. file) in which it was found. This may not be the same as name, which may have changed due to of a name conflict.

stateClass

stateClass: any

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static assetType

assetType: string

Accessors

dataLength

  • get (): number
  • Returns the length of the data used by the node when in LOCAL_STATIC mode. Used to generate the local static data of the particle animation set.

    see

    away.animators.ParticleAnimationSet

    see

    #getAGALVertexCode

    Returns number

mode

  • get (): number
  • Returns the property mode of the particle animation node. Typically set in the node constructor

    see

    away.animators.ParticlePropertiesMode

    Returns number

oneData

  • get (): Array<number>
  • Returns the generated data vector of the node after one particle pass during the generation of all local static data of the particle animation set.

    see

    away.animators.ParticleAnimationSet

    see

    #generatePropertyOfOneParticle

    Returns Array<number>

priority

  • get (): number
  • Returns the priority of the particle animation node, used to order the agal generated in a particle animation set. Set automatically on instantiation.

    see

    away.animators.ParticleAnimationSet

    see

    #getAGALVertexCode

    Returns number

Methods

_iGeneratePropertyOfOneParticle

_iProcessAnimationSetting

addEventListener

  • addEventListener(type: string, listener: function): void
  • Add an event listener

    method

    addEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns void

assetPathEquals

  • assetPathEquals(name: string, ns: string): boolean
  • Parameters

    • name: string
    • ns: string

    Returns boolean

clear

  • clear(): void
  • Returns void

dispatchEvent

  • dispatchEvent(event: EventBase): void
  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • inheritdoc

    Returns void

getAGALFragmentCode

  • getAGALFragmentCode(shader: ShaderBase, animationSet: ParticleAnimationSet, registerCache: ShaderRegisterCache, animationRegisterData: AnimationRegisterData): string
  • Returns the AGAL code of the particle animation node for use in the fragment shader.

    Parameters

    • shader: ShaderBase
    • animationSet: ParticleAnimationSet
    • registerCache: ShaderRegisterCache
    • animationRegisterData: AnimationRegisterData

    Returns string

getAGALUVCode

  • getAGALUVCode(shader: ShaderBase, animationSet: ParticleAnimationSet, registerCache: ShaderRegisterCache, animationRegisterData: AnimationRegisterData): string
  • Returns the AGAL code of the particle animation node for use in the fragment shader when UV coordinates are required.

    Parameters

    • shader: ShaderBase
    • animationSet: ParticleAnimationSet
    • registerCache: ShaderRegisterCache
    • animationRegisterData: AnimationRegisterData

    Returns string

getAGALVertexCode

  • getAGALVertexCode(shader: ShaderBase, animationSet: ParticleAnimationSet, registerCache: ShaderRegisterCache, animationRegisterData: AnimationRegisterData): string
  • inheritdoc

    Parameters

    • shader: ShaderBase
    • animationSet: ParticleAnimationSet
    • registerCache: ShaderRegisterCache
    • animationRegisterData: AnimationRegisterData

    Returns string

getAnimationState

  • inheritdoc

    Parameters

    • animator: AnimatorBase

    Returns ParticleTimeState

hasEventListener

  • hasEventListener(type: string, listener?: function): boolean
  • check if an object has an event listener assigned to it

    method

    hasListener

    Parameters

    • type: string
    • Optional listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns boolean

invalidate

  • invalidate(): void
  • Returns void

isAsset

  • isAsset(assetClass: IAssetClass): boolean
  • Parameters

    • assetClass: IAssetClass

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: function): void
  • Remove an event listener

    method

    removeEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns void

resetAssetPath

  • resetAssetPath(name: string, ns?: string, overrideOriginal?: boolean): void
  • Parameters

    • name: string
    • Optional ns: string
    • Optional overrideOriginal: boolean

    Returns void

updateFullPath

  • updateFullPath(): void
  • Returns void

Generated using TypeDoc