Options
Menu

Class EffectFogMethod

EffectFogMethod provides a method to add distance-based fog to a material.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

constructor

  • new EffectFogMethod(minDistance?: number, maxDistance?: number, fogColor?: number): EffectFogMethod
  • Creates a new EffectFogMethod object.

    Parameters

    • Default value minDistance: number = 0

      The distance from which the fog starts appearing.

    • Default value maxDistance: number = 1000

      The distance at which the fog is densest.

    • Default value fogColor: number = 8421504

      The colour of the fog.

    Returns EffectFogMethod

Properties

_adapter

_adapter: IAssetAdapter

_counts

_counts: Array<number>

_owners

_owners: Array<IMaterial>

_textures

_textures: Array<TextureBase>

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

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.

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static assetType

assetType: string

Accessors

assetType

  • get (): string
  • inheritdoc

    Returns string

fogColor

  • get (): number
  • set (value: number): void
  • The colour of the fog.

    Returns number

  • The colour of the fog.

    Parameters

    • value: number

    Returns void

maxDistance

  • get (): number
  • set (value: number): void
  • The distance at which the fog is densest.

    Returns number

  • The distance at which the fog is densest.

    Parameters

    • value: number

    Returns void

minDistance

  • get (): number
  • set (value: number): void
  • The distance from which the fog starts appearing.

    Returns number

  • The distance from which the fog starts appearing.

    Parameters

    • value: number

    Returns void

Methods

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

copyFrom

  • Copies the state from a ShadingMethodBase object into the current object.

    Parameters

    Returns void

dispatchEvent

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

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • Cleans up any resources used by the current object.

    Returns void

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

iAddOwner

  • iAddOwner(owner: IMaterial): void

iAddTexture

  • iAddTexture(texture: TextureBase): void

iRemoveOwner

  • iRemoveOwner(owner: IMaterial): void

iRemoveTexture

  • iRemoveTexture(texture: TextureBase): void

invalidate

  • invalidate(): void
  • Returns void

invalidateShaderProgram

  • invalidateShaderProgram(): void
  • Marks the shader program as invalid, so it will be recompiled before the next render.

    internal

    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