Options
Menu

Class DiffuseWrapMethod

DiffuseWrapMethod is an alternative to DiffuseBasicMethod in which the light is allowed to be "wrapped around" the normally dark area, to some extent. It can be used as a crude approximation to Oren-Nayar or simple subsurface scattering.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

constructor

  • Creates a new DiffuseWrapMethod object.

    Parameters

    • Default value wrapFactor: number = 0.5

      A factor to indicate the amount by which the light is allowed to wrap

    Returns DiffuseWrapMethod

Properties

_adapter

_adapter: IAssetAdapter

_counts

_counts: Array<number>

_owners

_owners: Array<IMaterial>

_pIsFirstLight

_pIsFirstLight: boolean

_texture

_texture: TextureBase

_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

color

  • get (): number
  • set (value: number): void
  • The color of the diffuse reflection when not using a texture.

    Returns number

  • The color of the diffuse reflection when not using a texture.

    Parameters

    • value: number

    Returns void

multiply

  • get (): boolean
  • set (value: boolean): void
  • Set internally if diffuse color component multiplies or replaces the ambient color

    Returns boolean

  • Set internally if diffuse color component multiplies or replaces the ambient color

    Parameters

    • value: boolean

    Returns void

texture

  • get (): TextureBase
  • set (value: TextureBase): void
  • The texture to use to define the diffuse reflection color per texel.

    Returns TextureBase

  • The texture to use to define the diffuse reflection color per texel.

    Parameters

    • value: TextureBase

    Returns void

wrapFactor

  • get (): number
  • set (value: number): void
  • A factor to indicate the amount by which the light is allowed to wrap.

    Returns number

  • A factor to indicate the amount by which the light is allowed to wrap.

    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

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