Options
Menu

Class EffectRefractionEnvMapMethod

EffectRefractionEnvMapMethod provides a method to add refracted transparency based on cube maps.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

constructor

  • new EffectRefractionEnvMapMethod(envMap: TextureBase, alpha?: number, refractionIndex?: number, dispersionR?: number, dispersionG?: number, dispersionB?: number): EffectRefractionEnvMapMethod
  • Creates a new EffectRefractionEnvMapMethod object. Example values for dispersion are: dispersionR: -0.03, dispersionG: -0.01, dispersionB: = .0015

    Parameters

    • envMap: TextureBase

      The environment map containing the refracted scene.

    • Default value alpha: number = 1
    • Default value refractionIndex: number = 0.1

      The refractive index of the material.

    • Default value dispersionR: number = 0

      The amount of chromatic dispersion of the red channel. Defaults to 0 (none).

    • Default value dispersionG: number = 0

      The amount of chromatic dispersion of the green channel. Defaults to 0 (none).

    • Default value dispersionB: number = 0

      The amount of chromatic dispersion of the blue channel. Defaults to 0 (none).

    Returns EffectRefractionEnvMapMethod

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

alpha

  • get (): number
  • set (value: number): void
  • The reflectivity of the surface.

    Returns number

  • The reflectivity of the surface.

    Parameters

    • value: number

    Returns void

assetType

  • get (): string

dispersionB

  • get (): number
  • set (value: number): void
  • The amount of chromatic dispersion of the blue channel. Defaults to 0 (none).

    Returns number

  • The amount of chromatic dispersion of the blue channel. Defaults to 0 (none).

    Parameters

    • value: number

    Returns void

dispersionG

  • get (): number
  • set (value: number): void
  • The amount of chromatic dispersion of the green channel. Defaults to 0 (none).

    Returns number

  • The amount of chromatic dispersion of the green channel. Defaults to 0 (none).

    Parameters

    • value: number

    Returns void

dispersionR

  • get (): number
  • set (value: number): void
  • The amount of chromatic dispersion of the red channel. Defaults to 0 (none).

    Returns number

  • The amount of chromatic dispersion of the red channel. Defaults to 0 (none).

    Parameters

    • value: number

    Returns void

envMap

  • get (): TextureBase
  • set (value: TextureBase): void
  • The cubic environment map containing the reflected scene.

    Returns TextureBase

  • The cubic environment map containing the reflected scene.

    Parameters

    • value: TextureBase

    Returns void

mask

  • get (): TextureBase
  • set (value: TextureBase): void
  • An optional texture to modulate the reflectivity of the surface.

    Returns TextureBase

  • An optional texture to modulate the reflectivity of the surface.

    Parameters

    • value: TextureBase

    Returns void

refractionIndex

  • get (): number
  • set (value: number): void
  • The refractive index of the material.

    Returns number

  • The refractive index of the material.

    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

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