Small World Engine API Reference - v0.78.00
    Preparing search index...

    Class PhongMaterial

    Material that implements the Phong reflection model.

    Hierarchy (View Summary)

    Index
    constructor
    _renderManifest alphaTest color cullMode depthTest depthWrite diffuseMap normalMap normalScale shininess specularColor specularMap transparent type uuid inspector
    _createBaseManifest _syncBaseManifestState _syncTexOffsetRepeat clone getRenderManifest getShaderDefinition

    Protected_renderManifest

    _renderManifest: RenderManifest | undefined = undefined

    Cached render manifest to avoid frequent allocations.

    alphaTest: number

    Alpha cutoff threshold.

    color: Color = ...

    The base color of the material.

    cullMode: CullMode = CullMode.DEFAULT

    The culling mode for this material. Defaults to BACK.

    depthTest: boolean = true

    Whether the material performs depth testing. Defaults to true.

    depthWrite: boolean = true

    Whether the material writes to the depth buffer. Defaults to true.

    diffuseMap: Texture | undefined

    The diffuse texture map.

    normalMap: Texture | undefined

    The normal map texture.

    normalScale: Vector2D

    Scale factor for the normal map to control strength and flip X/Y.

    shininess: number

    The shininess factor.

    specularColor: Color

    The specular reflection color.

    specularMap: Texture | undefined

    The specular map texture.

    transparent: boolean = false

    Whether the material is transparent. Defaults to false.

    type: string

    The type of the material.

    uuid: string = ...

    The unique identifier of the material.

    inspector: Record<string, InspectorField> = ...

    Own fields on top of AbstractMaterial.inspector -- see collectInspectorSchema().

    Protected_createBaseManifest

    Protected_syncBaseManifestState

    Protected_syncTexOffsetRepeat

    • _syncTexOffsetRepeat(
          tex:
              | {
                  offset: { x: number; y: number };
                  repeat: { x: number; y: number };
              }
              | undefined,
      ): void

      Helper to synchronize texture offset and repeat from a given texture.

      Parameters

      • tex:
            | { offset: { x: number; y: number }; repeat: { x: number; y: number } }
            | undefined

      Returns void

    • Returns an independent copy of this material (own uuid, own color/other value-type fields) -- geometry-adjacent references like texture maps stay shared, since texture data is immutable. Used by Object3D.clone() (Maker's Duplicate command) so a duplicated object's material edits don't leak back onto the original.

      Returns AbstractMaterial

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods