Options
Menu

Class EffectRimLightMethod

EffectRimLightMethod provides a method to add rim lighting to a material. This adds a glow-like effect to edges of objects.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new EffectRimLightMethod(color?: number, strength?: number, power?: number, blend?: string): EffectRimLightMethod

  • Creates a new EffectRimLightMethod object.

    Parameters

    • Default value color: number = 16777215

      The colour of the rim light.

    • Default value strength: number = 0.4

      The strength of the rim light.

    • Default value power: number = 2

      The power of the rim light. Higher values will result in a higher edge fall-off.

    • Default value blend: string = "mix"

      The blend mode with which to add the light to the object.

    Returns EffectRimLightMethod

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 ADD

ADD: string

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static MIX

MIX: string

Static MULTIPLY

MULTIPLY: string

Static assetType

assetType: string

Accessors

assetType

  • get (): string
  • inheritdoc

    Returns string

blendMode

  • get (): string
  • set (value: string): void

  • The blend mode with which to add the light to the object.

    EffectRimLightMethod.MULTIPLY multiplies the rim light with the material's colour. EffectRimLightMethod.ADD adds the rim light with the material's colour. EffectRimLightMethod.MIX provides normal alpha blending.

    Returns string

  • The blend mode with which to add the light to the object.

    EffectRimLightMethod.MULTIPLY multiplies the rim light with the material's colour. EffectRimLightMethod.ADD adds the rim light with the material's colour. EffectRimLightMethod.MIX provides normal alpha blending.

    Parameters

    • value: string

    Returns void

color

  • get (): number
  • set (value: number): void

  • The color of the rim light.

    Returns number

  • The color of the rim light.

    Parameters

    • value: number

    Returns void

power

  • get (): number
  • set (value: number): void

  • The power of the rim light. Higher values will result in a higher edge fall-off.

    Returns number

  • The power of the rim light. Higher values will result in a higher edge fall-off.

    Parameters

    • value: number

    Returns void

strength

  • get (): number
  • set (value: number): void

  • The strength of the rim light.

    Returns number

  • The strength of the rim light.

    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