Home Manual Reference Source
import S3Light from 's3js/src/basic/S3Light.js'
public class | source

S3Light

3DCGシーン用のライト(照明)情報を管理するクラス 各種ライト(環境光・平行光源・点光源など)のモード・強さ・方向・色などを保持します。

Constructor Summary

Public Constructor
public

ライト情報を初期化して作成します。

Member Summary

Public Members
public

ライトの色(RGB値のベクトル)

public

ライトの方向ベクトル(主に平行光源で使用)

public

ライトの種類(モード)を指定します。S3Light.MODEを参照。

public

ライトの位置ベクトル(主に点光源で使用)

public

ライトの強さ(1.0=通常、0.0=無効)

public

ライトの影響範囲(主に点光源で使用)

Method Summary

Public Methods
public

clone(Instance: typeof S3Light): S3Light

このライト情報のクローン(複製)を作成します。

public

init()

ライト情報を初期値でリセットします。 モードや強度、範囲、方向、色なども初期状態に戻ります。

public

setColor(color: S3Vector)

ライトの色を設定します(RGB)。

public

setDirection(direction: S3Vector)

ライトの方向を設定します(平行光源等)。

public

setMode(mode: number)

ライトの種類(モード)を設定します。

public

setPosition(position: S3Vector)

ライトの位置を設定します(点光源等)。

public

setPower(power: number)

ライトの強さを設定します。

public

setRange(range: number)

ライトの影響範囲を設定します(点光源等)。

Public Constructors

public constructor() source

ライト情報を初期化して作成します。

Public Members

public color: S3Vector source

ライトの色(RGB値のベクトル)

public direction: S3Vector source

ライトの方向ベクトル(主に平行光源で使用)

public mode: number source

ライトの種類(モード)を指定します。S3Light.MODEを参照。

public position: S3Vector source

ライトの位置ベクトル(主に点光源で使用)

public power: number source

ライトの強さ(1.0=通常、0.0=無効)

public range: number source

ライトの影響範囲(主に点光源で使用)

Public Methods

public clone(Instance: typeof S3Light): S3Light source

このライト情報のクローン(複製)を作成します。

Params:

NameTypeAttributeDescription
Instance typeof S3Light
  • optional

クラス指定(省略時はS3Light)

Return:

S3Light

複製されたライトインスタンス

public init() source

ライト情報を初期値でリセットします。 モードや強度、範囲、方向、色なども初期状態に戻ります。

public setColor(color: S3Vector) source

ライトの色を設定します(RGB)。

Params:

NameTypeAttributeDescription
color S3Vector

色ベクトル

public setDirection(direction: S3Vector) source

ライトの方向を設定します(平行光源等)。

Params:

NameTypeAttributeDescription
direction S3Vector

方向ベクトル

public setMode(mode: number) source

ライトの種類(モード)を設定します。

Params:

NameTypeAttributeDescription
mode number

S3Light.MODEで定義される値

public setPosition(position: S3Vector) source

ライトの位置を設定します(点光源等)。

Params:

NameTypeAttributeDescription
position S3Vector

位置ベクトル

public setPower(power: number) source

ライトの強さを設定します。

Params:

NameTypeAttributeDescription
power number

強度(通常1.0、0.0で無効)

public setRange(range: number) source

ライトの影響範囲を設定します(点光源等)。

Params:

NameTypeAttributeDescription
range number

範囲