API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PBRAnisotropicConfiguration

Define the code related to the anisotropic parameters of the pbr material.

Hierarchy

  • PBRAnisotropicConfiguration

Index

Constructors

Properties

Methods

Constructors

constructor

  • Instantiate a new istance of anisotropy configuration.

    Parameters

    • markAllSubMeshesAsTexturesDirty: () => void

      Callback to flag the material to dirty

        • (): void

        • Returns void

    Returns PBRAnisotropicConfiguration

Properties

directionSearch playground for direction

direction: Vector2

Defines if the effect is along the tangents, bitangents or in between. By default, the effect is "strectching" the highlights along the tangents.

intensitySearch playground for intensity

intensity: number

Defines the anisotropy strength (between 0 and 1) it defaults to 1.

isEnabledSearch playground for isEnabled

isEnabled: boolean

Defines if the anisotropy is enabled in the material.

textureSearch playground for texture

texture: Nullable<BaseTexture>

Stores the anisotropy values in a texture. rg is direction (like normal from -1 to 1) b is a intensity

Methods

bindForSubMeshSearch playground for bindForSubMesh

  • Binds the material data.

    Parameters

    • uniformBuffer: UniformBuffer

      defines the Uniform buffer to fill in.

    • scene: Scene

      defines the scene the material belongs to.

    • isFrozen: boolean

      defines wether the material is frozen or not.

    Returns void

copyToSearch playground for copyTo

  • Makes a duplicate of the current configuration into another one.

    Parameters

    Returns void

disposeSearch playground for dispose

  • dispose(forceDisposeTextures?: boolean): void

  • Disposes the resources of the material.

    Parameters

    • Optional forceDisposeTextures: boolean

      Forces the disposal of all textures.

    Returns void

getActiveTexturesSearch playground for getActiveTextures

  • getActiveTextures(activeTextures: BaseTexture[]): void

  • Returns an array of the actively used textures.

    Parameters

    Returns void

getAnimatablesSearch playground for getAnimatables

  • Returns the animatable textures.

    Parameters

    • animatables: IAnimatable[]

      Array of animatable textures.

    Returns void

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Get the current class name of the texture useful for serialization or dynamic coding.

    Returns string

    "PBRAnisotropicConfiguration"

hasTextureSearch playground for hasTexture

  • Checks to see if a texture is used in the material.

    Parameters

    Returns boolean

    • Boolean specifying if a texture is used in the material.

isReadyForSubMeshSearch playground for isReadyForSubMesh

  • isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean

  • Specifies that the submesh is ready to be used.

    Parameters

    • defines: IMaterialAnisotropicDefines

      the list of "defines" to update.

    • scene: Scene

      defines the scene the material belongs to.

    Returns boolean

    • boolean indicating that the submesh is ready or not.

parseSearch playground for parse

  • parse(source: any, scene: Scene, rootUrl: string): void

  • Parses a anisotropy Configuration from a serialized object.

    Parameters

    • source: any

      Serialized object.

    • scene: Scene

      Defines the scene we are parsing for

    • rootUrl: string

      Defines the rootUrl to load from

    Returns void

prepareDefinesSearch playground for prepareDefines

  • prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void

  • Checks to see if a texture is used in the material.

    Parameters

    • defines: IMaterialAnisotropicDefines

      the list of "defines" to update.

    • mesh: AbstractMesh

      the mesh we are preparing the defines for.

    • scene: Scene

      defines the scene the material belongs to.

    Returns void

serializeSearch playground for serialize

  • serialize(): any

  • Serializes this anisotropy configuration.

    Returns any

    • An object with the serialized config.

Static AddFallbacksSearch playground for AddFallbacks

  • AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number

  • Add fallbacks to the effect fallbacks list.

    Parameters

    • defines: IMaterialAnisotropicDefines

      defines the Base texture to use.

    • fallbacks: EffectFallbacks

      defines the current fallback list.

    • currentRank: number

      defines the current fallback rank.

    Returns number

    the new fallback rank.

Static AddSamplersSearch playground for AddSamplers

  • AddSamplers(samplers: string[]): void

  • Add the required samplers to the current list.

    Parameters

    • samplers: string[]

      defines the current sampler list.

    Returns void

Static AddUniformsSearch playground for AddUniforms

  • AddUniforms(uniforms: string[]): void

  • Add the required uniforms to the current list.

    Parameters

    • uniforms: string[]

      defines the current uniform list.

    Returns void

Static PrepareUniformBufferSearch playground for PrepareUniformBuffer

  • Add the required uniforms to the current buffer.

    Parameters

    • uniformBuffer: UniformBuffer

      defines the current uniform buffer.

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method