Options
All
  • Public
  • Public/Protected
  • All
Menu

A behavior that when attached to a mesh will allow the mesh to fade in and out

Hierarchy

  • FadeInOutBehavior

Implements

Index

Constructors

  • Instantiates the FadeInOutBehavior

    Returns FadeInOutBehavior

Properties

fadeInDelay: number

Time in milliseconds to delay before fading in (Default: 0)

fadeInTime: number

Time in milliseconds for the mesh to fade in (Default: 300)

fadeOutDelay: number

Time in milliseconds to delay before fading out (Default: 0)

fadeOutTime: number

Time in milliseconds for the mesh to fade out (Default: 300)

Accessors

  • get delay(): number
  • set delay(value: number): void
  • Time in milliseconds to delay before fading in (Default: 0) Will set both fade in and out delay to the same value

    Returns number

  • Time in milliseconds to delay before fading in (Default: 0) Will set both fade in and out delay to the same value

    Parameters

    • value: number

    Returns void

  • get name(): string
  • The name of the behavior

    Returns string

Methods

  • attach(ownerNode: Mesh): void
  • Attaches the fade behavior on the passed in mesh

    Parameters

    • ownerNode: Mesh

      The mesh that will be faded in/out once attached

    Returns void

  • detach(): void
  • Detaches the behavior from the mesh

    Returns void

  • fadeIn(fadeIn?: boolean): void
  • Triggers the mesh to begin fading in (or out)

    Parameters

    • Optional fadeIn: boolean

      if the object should fade in or out (true to fade in)

    Returns void

  • fadeOut(): void
  • Triggers the mesh to begin fading out

    Returns void

  • init(): void
  • Initializes the behavior

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme