Options
Menu

Class SpecularCelMethod

SpecularCelMethod provides a shading method to add specular cel (cartoon) shading.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

constructor

  • Creates a new SpecularCelMethod object.

    Parameters

    • Default value specularCutOff: number = 0.5

      The threshold at which the specular highlight should be shown.

    • Default value smoothness: number = 0.1

      The smoothness of the highlight edge.

    • Default value baseMethod: SpecularBasicMethod | SpecularCompositeMethod = null

      An optional specular method on which the cartoon shading is based. If ommitted, SpecularBasicMethod is used.

    Returns SpecularCelMethod

Properties

_adapter

_adapter: IAssetAdapter

Protected _baseMethod

_baseMethod: ShadingMethodBase

_counts

_counts: Array<number>

Protected _onShaderInvalidatedDelegate

_onShaderInvalidatedDelegate: function

Type declaration

    • (event: ShadingMethodEvent): void
    • Parameters

      • event: ShadingMethodEvent

      Returns void

_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

baseMethod

color

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

gloss

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

smoothness

  • get (): number
  • set (value: number): void
  • The smoothness of the highlight edge.

    Returns number

  • The smoothness of the highlight edge.

    Parameters

    • value: number

    Returns void

specularCutOff

  • get (): number
  • set (value: number): void
  • The threshold at which the specular highlight should be shown.

    Returns number

  • The threshold at which the specular highlight should be shown.

    Parameters

    • value: number

    Returns void

strength

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

texture

  • get (): TextureBase
  • set (value: TextureBase): 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

createBaseMethod

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