前のページ次のページ上に戻るホーム SophiaFramework 2.2
SFUColor3D
3D カラーを表すクラスです。
#include <SFUColor3D.hpp>
class SFUColor3D;
typedef SFUColor3D&          SFUColor3DRef;
typedef SFUColor3D*          SFUColor3DPtr;
typedef SFUColor3D**         SFUColor3DHandle;
typedef const SFUColor3D     ConstSFUColor3D;
typedef const SFUColor3D&    ConstSFUColor3DRef;
typedef const SFUColor3D*    ConstSFUColor3DPtr;
typedef const SFUColor3D**   ConstSFUColor3DHandle;

協調図

SFUColor3D クラスの協調図

解説

SFUColor3D は 3D カラーを表すクラスです。 3D カラーは GUI コントロールを描画する色で、 ベース カラー(B)、ライト カラー(L)、シャドウ カラー(S) の 3 つの SFUColor で構成されます。

ベース カラーはコントロールの表面を描画するときの色です。 ライト カラーはコントロールの左端と上端を描画するときの色です。 シャドウ カラーはコントロールの右端と下端を描画するときの色です。 この 3 つの色を使うことでコントロールに 3D 効果を与えることができます。

参照

SFUColor

メンバ

コンストラクタ/デストラクタ
public
SFUColor3D SFUColor3D クラスのコンストラクタです。
public
~SFUColor3D SFUColor3D クラスのデストラクタです。
パブリック関数
public
AddAlpha 3D カラーを構成する各カラーにアルファ値を加算します。
public
AddRgb 3D カラーを構成する各カラーに RGB 値を加算します。
public
B ベース カラーを取得/設定します。
public
Equal 3D カラーが等しいか判定します。
public
EqualAlpha 3D カラーを構成する 3 つのカラーのアルファ値がすべて等しいか判定します。
public
EqualRgb 3D カラーを構成する 3 つのカラーの RGB 値がすべて等しいか判定します。
public
L ライト カラーを取得/設定します。
public
S シャドウ カラーを取得/設定します。
public
Set 3D カラーを構成する各カラーを設定します。
public
SubAlpha 3D カラーを構成する各カラーからアルファ値を減算します。
public
SubRgb 3D カラーを構成する各カラーから RGB 値を減算します。
public
operator+ 3D カラーを構成する各カラーを加算します。
public
operator- 3D カラーを構成する各カラーを減算します。
public
operator== 3D カラーが等しいか判定します。

SFUColor3D::SFUColor3D
SFUColor3D クラスのコンストラクタです。
[ public ]
SFUColor3D(Void);
[ public ]
SFUColor3D(
    ConstSFUColor3DRef color3d   // コピー元の 3D カラー
);
[ public ]
SFUColor3D(
    ConstSFUColorRef base     // ベース カラー
    ConstSFUColorRef light    // ライト カラー
    ConstSFUColorRef shadow   // シャドウ カラー
);
[ public ]
SFUColor3D(
    ConstSFUColorRef color   // ベース、ライト、シャドウに設定するカラー
);

参照

SFUColor3D::Set


SFUColor3D::~SFUColor3D
SFUColor3D クラスのデストラクタです。
[ public ]
~SFUColor3D(Void);

SFUColor3D::AddAlpha
3D カラーを構成する各カラーにアルファ値を加算します。
[ public ]
ConstSFUColor3DRef AddAlpha(
    SInt16 alpha   // アルファ値に加算する値
);

戻り値

自分自身を返します。

解説

カラーのアルファ値の加算については SFUColor::AddAlpha を参照してください。

参照

SFUColor::AddAlpha | SFUColor3D::AddRgb


SFUColor3D::AddRgb
3D カラーを構成する各カラーに RGB 値を加算します。
[ public ]
ConstSFUColor3DRef AddRgb(
    SInt16 r   // 赤に加算する値
    SInt16 g   // 緑に加算する値
    SInt16 b   // 青に加算する値
);
[ public ]
ConstSFUColor3DRef AddRgb(
    SInt16 value   // 赤、緑、青に加算する値
);

戻り値

自分自身を返します。

解説

カラーの RGB 値の加算については SFUColor::AddRgb を参照してください。

参照

SFUColor::AddRgb | SFUColor3D::AddAlpha


SFUColor3D::B
ベース カラーを取得/設定します。
[ public ]
Void B(
    ConstSFUColorRef baseColor   // 設定するベースカラー
);
[ public, const ]
ConstSFUColorRef B(Void);

SFUColor3D::Equal
3D カラーが等しいか判定します。
[ public, const ]
Bool Equal(
    ConstSFUColor3DRef color   
);

戻り値

ベース カラー、ライト カラー、シャドウ カラーの 3 つがすべて等しければ TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor3D::operator==


SFUColor3D::EqualAlpha
3D カラーを構成する 3 つのカラーのアルファ値がすべて等しいか判定します。
[ public, const ]
Bool EqualAlpha(
    ConstSFUColor3DRef color3D   // 比較対象の 3D カラー
);

戻り値

3D カラーを構成する 3 つのカラーのアルファ値がすべて等しければ TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor::EqualAlpha


SFUColor3D::EqualRgb
3D カラーを構成する 3 つのカラーの RGB 値がすべて等しいか判定します。
[ public, const ]
Bool EqualRgb(
    ConstSFUColor3DRef color3d   // 比較対象の 3D カラー
);

戻り値

3D カラーを構成する 3 つのカラーの RGB 値がすべて等しければ TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor::EqualRgb


SFUColor3D::L
ライト カラーを取得/設定します。
[ public ]
Void L(
    ConstSFUColorRef lightColor   // 設定するライト カラー
);
[ public, const ]
ConstSFUColorRef L(Void);

SFUColor3D::S
シャドウ カラーを取得/設定します。
[ public ]
Void S(
    ConstSFUColorRef shadowColor   // 設定するシャドウ カラー
);
[ public, const ]
ConstSFUColorRef S(Void);

SFUColor3D::Set
3D カラーを構成する各カラーを設定します。
[ public ]
ConstSFUColor3DRef Set(
    ConstSFUColorRef base     // ベース カラー
    ConstSFUColorRef light    // ライト カラー
    ConstSFUColorRef shadow   // シャドウ カラー
);
[ public ]
ConstSFUColor3DRef Set(
    ConstSFUColorRef color   // ベース、ライト、シャドウに設定するカラー
);

戻り値

自分自身を返します。

参照

SFUColor3D::SFUColor3D


SFUColor3D::SubAlpha
3D カラーを構成する各カラーからアルファ値を減算します。
[ public ]
ConstSFUColor3DRef SubAlpha(
    SInt16 alpha   // アルファ値から減算する値
);

戻り値

自分自身を返します。

解説

カラーのアルファ値の減算については SFUColor::SubAlpha を参照してください。

参照

SFUColor::SubAlpha | SFUColor3D::SubRgb


SFUColor3D::SubRgb
3D カラーを構成する各カラーから RGB 値を減算します。
[ public ]
ConstSFUColor3DRef SubRgb(
    SInt16 r   // 赤から減算する値
    SInt16 g   // 緑から減算する値
    SInt16 b   // 青から減算する値
);
[ public ]
ConstSFUColor3DRef SubRgb(
    SInt16 value   // 赤、緑、青から減算する値
);

戻り値

自分自身を返します。

解説

カラーの RGB 値の減算については SFUColor::SubRgb を参照してください。

参照

SFUColor::SubRgb | SFUColor3D::SubAlpha


SFUColor3D::operator==
3D カラーが等しいか判定します。
[ public, friend ]
Bool operator==(
    ConstSFUColor3DRef tdcolor1   
    ConstSFUColor3DRef tdcolor3   
);
[ public, friend ]
Bool operator!=(
    ConstSFUColor3DRef tdcolor1   
    ConstSFUColor3DRef tdcolor2   
);

解説

ベース カラー、ライト カラー、シャドウ カラーの 3 つがすべて等しければ TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor3D::Equal


SFUColor3D::operator-
3D カラーを構成する各カラーを減算します。
[ public, friend ]
SFUColor3D operator-(
    ConstSFUColor3DRef tdcolor1   
    ConstSFUColor3DRef tdcolor2   
);
[ public ]
ConstSFUColor3DRef operator-=(
    ConstSFUColor3DRef tdcolor   
);

解説

2 つの 3D カラーのベース カラー、ライト カラー、シャドウ カラーを それぞれ減算した 3D カラーを返します。

カラーの減算については SFUColor::operator- を参照してください。

参照

SFUColor3D::operator+


SFUColor3D::operator+
3D カラーを構成する各カラーを加算します。
[ public, friend ]
SFUColor3D operator+(
    ConstSFUColor3DRef tdcolor1   
    ConstSFUColor3DRef tdcolor2   
);
[ public ]
ConstSFUColor3DRef operator+=(
    ConstSFUColor3DRef tdcolor   
);

解説

2 つの 3D カラーのベース カラー、ライト カラー、シャドウ カラーを それぞれ加算した 3D カラーを返します。

カラーの加算については SFUColor::operator+ を参照してください。

参照

SFUColor3D::operator-