前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXGrid
画面上の格子点を表すグリッド座標を扱うためのクラスです。
#include <SFXGrid.h.hpp>
class SFXGrid;
SFMTYPEDEFCLASS(SFXGrid)

解説

SFXGrid クラスは、 画面上の格子点（グリッド）を表すグリッド座標を扱うためのクラスです。

SFXGrid::AtomRec 構造体は画面上の格子点（グリッド）を表すグリッド座標を表す構造体であり、 格子点（グリッド）の X 座標と Y 座標を持ちます。

定数の SFXGrid インスタンスは、コンストラクタを呼び出すことなく、 SFXGrid::AtomRec 構造体を利用して高速に設定することが可能です。

[Note] グリッド座標系とピクセル座標系

SophiaFramework UNIVERSE には、グリッド座標系とピクセル座標系の 2 つの座標系があります。

両者の違いを図で表すと、次のようになります。

囲碁や将棋に例えると、 「描画する平面」は盤面、 「グリッド」は囲碁の碁石を置く場所、 「ピクセル」は将棋の駒を置く場所です。

参照

SFXGrid::AtomRec | SFXPixel | BREW API AEEPoint

メンバ

コンストラクタ/デストラクタ
SFXGrid( Void )
SFXGrid クラスのコンストラクタです。
SFXGrid( SFXGridConstRef param )
SFXGrid クラスのコンストラクタです。
SFXGrid( SInt16 x , SInt16 y )
SFXGrid クラスのコンストラクタです。
SFXGrid( SFXSizeConstRef size )
SFXGrid クラスのコンストラクタです。
パブリック関数
SFXGridRef Add( SFXGridConstRef param )
この格子点の座標に指定された値を加算します。
SFXGridRef Add( SInt16 x , SInt16 y )
この格子点の座標に指定された値を加算します。
SFXGridRef Add( SFXSizeConstRef size )
この格子点の座標に指定された値を加算します。
SFXGridRef AddX( SInt16 param )
この格子点の X 座標に指定された値を加算します。
SFXGridRef AddY( SInt16 param )
この格子点の Y 座標に指定された値を加算します。
SFXGridRef Div( SInt16 x , SInt16 y )
この格子点の座標を指定された値で除算します。
SFXGridRef Div( SInt16 param )
この格子点の座標を指定された値で除算します。
SFXGridRef DivX( SInt16 param )
この格子点の X 座標を指定された値で除算します。
SFXGridRef DivY( SInt16 param )
この格子点の Y 座標を指定された値で除算します。
Bool Equals( SFXGridConstRef param )
この格子点の座標が指定された値と等しいか判定します。
Bool Equals( SInt16 x , SInt16 y )
この格子点の座標が指定された値と等しいか判定します。
Bool Equals( SFXSizeConstRef size )
この格子点の座標が指定された値と等しいか判定します。
SFXPixel GetLeftBottom( Void )
この格子点の左下ピクセルの座標を取得します。
SFXPixel GetLeftTop( Void )
この格子点の左上ピクセルの座標を取得します。
SFXPixel GetRightBottom( Void )
この格子点の右下ピクセルの座標を取得します。
SFXPixel GetRightTop( Void )
この格子点の右上ピクセルの座標を取得します。
SInt16 GetX( Void )
この格子点の X 座標を取得します。
SInt16 GetY( Void )
この格子点の Y 座標を取得します。
Bool IsInsideOf( SFXRectangleConstRef param )
この格子点の座標が指定された矩形領域の中に含まれるか判定します。
SFXGridRef Mod( SInt16 x , SInt16 y )
この格子点の座標を指定された値で剰余します。
SFXGridRef Mod( SInt16 param )
この格子点の座標を指定された値で剰余します。
SFXGridRef ModX( SInt16 param )
この格子点の X 座標を指定された値で剰余します。
SFXGridRef ModY( SInt16 param )
この格子点の Y 座標を指定された値で剰余します。
SFXGridRef Mul( SInt16 x , SInt16 y )
この格子点の座標に指定された値を乗算します。
SFXGridRef Mul( SInt16 param )
この格子点の座標に指定された値を乗算します。
SFXGridRef MulX( SInt16 param )
この格子点の X 座標に指定された値を乗算します。
SFXGridRef MulY( SInt16 param )
この格子点の Y 座標に指定された値を乗算します。
SFXGridRef Neg( Void )
この格子点の座標の符号を反転します。
SFXGridRef NegX( Void )
この格子点の X 座標の符号を反転します。
SFXGridRef NegY( Void )
この格子点の Y 座標の符号を反転します。
SFXGridRef Set( SFXGridConstRef param )
この格子点の座標を指定された値に設定します。
SFXGridRef Set( SInt16 x , SInt16 y )
この格子点の座標を指定された値に設定します。
SFXGridRef Set( SFXSizeConstRef size )
この格子点の座標を指定された値に設定します。
SFXGridRef SetLeftBottom( SFXPixelConstRef param )
左下ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetLeftBottom( SInt16 x , SInt16 y )
左下ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetLeftTop( SFXPixelConstRef param )
左上ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetLeftTop( SInt16 x , SInt16 y )
左上ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetRightBottom( SFXPixelConstRef param )
右下ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetRightBottom( SInt16 x , SInt16 y )
右下ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetRightTop( SFXPixelConstRef param )
右上ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetRightTop( SInt16 x , SInt16 y )
右上ピクセルの座標を指定してこの格子点の座標を設定します。
SFXGridRef SetX( SInt16 param )
この格子点の X 座標を指定された値に設定します。
SFXGridRef SetY( SInt16 param )
この格子点の Y 座標を指定された値に設定します。
SFXGridRef Sub( SFXGridConstRef param )
この格子点の座標から指定された値を減算します。
SFXGridRef Sub( SInt16 x , SInt16 y )
この格子点の座標から指定された値を減算します。
SFXGridRef Sub( SFXSizeConstRef size )
この格子点の座標から指定された値を減算します。
SFXGridRef SubX( SInt16 param )
この格子点の X 座標から指定された値を減算します。
SFXGridRef SubY( SInt16 param )
この格子点の Y 座標から指定された値を減算します。
static
SFXGridConstRef 		ZeroInstance( Void )
0 を表す SFXGrid インスタンスを取得します。
SFXGridRef operator%=( SInt16 param )
左側の格子点の座標を右側の値で剰余します。
SFXGridRef operator*=( SInt16 param )
左側の格子点の座標を右側の値で乗算します。
SFXGridRef operator+=( SFXGridConstRef param )
左側の格子点の座標に右側の値を加算します。
SFXGridRef operator+=( SFXSizeConstRef size )
左側の格子点の座標に右側の値を加算します。
SFXGridRef operator-=( SFXGridConstRef param )
左側の格子点の座標から右側の値を減算します。
SFXGridRef operator-=( SFXSizeConstRef size )
左側の格子点の座標から右側の値を減算します。
SFXGridRef operator/=( SInt16 param )
左側の格子点の座標を右側の値で除算します。
SFXGridRef operator=( SFXGridConstRef param )
左側の格子点の座標に右側の値を代入します。
SFXGridRef operator=( SFXSizeConstRef size )
左側の格子点の座標に右側の値を代入します。
SFXGrid::AtomRec * atomic_cast( SFXGrid * param )
SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。
SFXGrid::AtomRec const * atomic_cast( SFXGrid const * param )
SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。
AEEPoint * interface_cast( SFXGrid * param )
SFXGrid クラスを AEEPoint 構造体に型変換します。
AEEPoint const * interface_cast( SFXGrid const * param )
SFXGrid クラスを AEEPoint 構造体に型変換します。
SFXGrid operator/( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で除算した格子点の座標を返します。
Bool operator==( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標が右側の値と等しいか判定します。
Bool operator==( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標が右側の値と等しいか判定します。
SFXGrid operator-( Void )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator-( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator-( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator%( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で剰余した格子点の座標を返します。
SFXGrid operator*( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で乗算した格子点の座標を返します。
Bool operator!=( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標が右側の値と異なるか判定します。
Bool operator!=( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標が右側の値と異なるか判定します。
SFXGrid operator+( Void )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
SFXGrid operator+( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
SFXGrid operator+( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
型
AtomRec
格子点を表す構造体です。
グローバル関数
SFXGrid::AtomRec * atomic_cast( SFXGrid * param )
SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。
SFXGrid::AtomRec const * atomic_cast( SFXGrid const * param )
SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。
AEEPoint * interface_cast( SFXGrid * param )
SFXGrid クラスを AEEPoint 構造体に型変換します。
AEEPoint const * interface_cast( SFXGrid const * param )
SFXGrid クラスを AEEPoint 構造体に型変換します。
SFXGrid operator/( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で除算した格子点の座標を返します。
Bool operator==( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標が右側の値と等しいか判定します。
Bool operator==( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標が右側の値と等しいか判定します。
SFXGrid operator-( Void )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator-( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator-( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
SFXGrid operator%( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で剰余した格子点の座標を返します。
SFXGrid operator*( SFXGridConstRef left , SInt16 right )
左側の格子点の座標を右側の値で乗算した格子点の座標を返します。
Bool operator!=( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標が右側の値と異なるか判定します。
Bool operator!=( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標が右側の値と異なるか判定します。
SFXGrid operator+( Void )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
SFXGrid operator+( SFXGridConstRef left , SFXGridConstRef right )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
SFXGrid operator+( SFXGridConstRef left , SFXSizeConstRef right )
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
SFXGrid::SFXGrid
SFXGrid クラスのコンストラクタです。
[ public, explicit ]
SFXGrid(Void);
[ public ]
SFXGrid(
    SFXGridConstRef param   // 元となる SFXGrid オブジェクト
);
[ public, explicit ]
SFXGrid(
    SInt16 x   //  X 座標
    SInt16 y   //  Y 座標
);
[ public, explicit ]
SFXGrid(
    SFXSizeConstRef size   // 幅と高さ
);

解説

引数にが指定された場合、 このコンストラクタは、 内部的に SFXGrid::Set 関数を呼び出して指定された値でこのグリッド座標を初期設定します。

[Note] 注意

SFXSize インスタンスを引数に指定した場合、その幅を X 座標に、高さを Y 座標に設定します。

参照

SFXGrid::Set | BREW API AEEPoint

SFXGrid::Add
この格子点の座標に指定された値を加算します。
[ public ]
SFXGridRef Add(
    SFXGridConstRef param   // この格子点の座標に加算する値
);
[ public ]
SFXGridRef Add(
    SInt16 x   // この格子点の X 座標に加算する値
    SInt16 y   // この格子点の Y 座標に加算する値
);
[ public ]
SFXGridRef Add(
    SFXSizeConstRef size   // この格子点の座標に加算する値
);

戻り値

この格子点の座標に指定された値を加算した後のこの格子点の座標

解説

この関数は、この格子点の座標に指定された値を加算します。

[Note] 注意

この格子点の座標は指定された値を加算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::AddX | SFXGrid::AddY | SFXGrid::Sub | SFXGrid::Mul | SFXGrid::Div | SFXGrid::Mod | SFXGrid::Neg | SFXGrid::operator+=

SFXGrid::AddX
この格子点の X 座標に指定された値を加算します。
[ public ]
SFXGridRef AddX(
    SInt16 param   // 加算する値
);

戻り値

この格子点の X 座標に指定された値を加算した後のこの格子点の座標

解説

この関数は、この格子点の X 座標に指定された値を加算します。

[Note] 注意

この格子点の座標は指定された値を加算した分だけ移動します。

参照

SFXGrid::Add | SFXGrid::AddY | SFXGrid::SubX | SFXGrid::MulX | SFXGrid::DivX | SFXGrid::ModX | SFXGrid::NegX

SFXGrid::AddY
この格子点の Y 座標に指定された値を加算します。
[ public ]
SFXGridRef AddY(
    SInt16 param   // 加算する値
);

戻り値

この格子点の Y 座標に指定された値を加算した後のこの格子点の座標

解説

この関数は、この格子点の Y 座標に指定された値を加算します。

[Note] 注意

この格子点の座標は指定された値を加算した分だけ移動します。

参照

SFXGrid::Add | SFXGrid::AddX | SFXGrid::SubY | SFXGrid::MulY | SFXGrid::DivY | SFXGrid::ModY | SFXGrid::NegY

SFXGrid::Div
この格子点の座標を指定された値で除算します。
[ public ]
SFXGridRef Div(
    SInt16 x   // この格子点の X 座標を除算する値
    SInt16 y   // この格子点の Y 座標を除算する値
);
[ public ]
SFXGridRef Div(
    SInt16 param   // この格子点の座標を除算する値
);

戻り値

この格子点の座標を指定された値で除算した後のこの格子点の座標

解説

この関数は、この格子点の座標を指定された値で除算します。

x、y、または param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で除算した分だけ移動します。

参照

SFXGrid::Add | SFXGrid::Sub | SFXGrid::Mul | SFXGrid::DivX | SFXGrid::DivY | SFXGrid::Mod | SFXGrid::Neg | operator/ | SFXGrid::operator/=

SFXGrid::DivX
この格子点の X 座標を指定された値で除算します。
[ public ]
SFXGridRef DivX(
    SInt16 param   // 除算する値
);

戻り値

この格子点の X 座標を指定された値で除算した後のこの格子点の座標

解説

この関数は、この格子点の X 座標を指定された値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で除算した分だけ移動します。

参照

SFXGrid::Div | SFXGrid::DivY | SFXGrid::AddX | SFXGrid::SubX | SFXGrid::MulX | SFXGrid::ModX | SFXGrid::NegX

SFXGrid::DivY
この格子点の Y 座標を指定された値で除算します。
[ public ]
SFXGridRef DivY(
    SInt16 param   // 除算する値
);

戻り値

この格子点の Y 座標を指定された値で除算した後のこの格子点の座標

解説

この関数は、この格子点の Y 座標を指定された値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で除算した分だけ移動します。

参照

SFXGrid::Div | SFXGrid::DivX | SFXGrid::AddY | SFXGrid::SubY | SFXGrid::MulY | SFXGrid::ModY | SFXGrid::NegY

SFXGrid::Equals
この格子点の座標が指定された値と等しいか判定します。
[ public, const ]
Bool Equals(
    SFXGridConstRef param   // 比較対象の格子点
);
[ public, const ]
Bool Equals(
    SInt16 x   // 比較対象の X 座標
    SInt16 y   // 比較対象の Y 座標
);
[ public, const ]
Bool Equals(
    SFXSizeConstRef size   // 比較対象のサイズ
);

戻り値

  • 等しいとき: true
  • そうでないとき: false

解説

この関数は、この格子点の座標が指定された値と等しいか判定します。

[Note] 注意

指定された値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

operator== | operator!=

SFXGrid::GetLeftBottom
この格子点の左下ピクセルの座標を取得します。
[ public, const ]
SFXPixel GetLeftBottom(Void);

戻り値

この格子点の左下ピクセルの座標

解説

この関数は、この格子点の左下ピクセルの座標を取得します。

参照

SFXGrid::SetLeftBottom

SFXGrid::GetLeftTop
この格子点の左上ピクセルの座標を取得します。
[ public, const ]
SFXPixel GetLeftTop(Void);

戻り値

この格子点の左上ピクセルの座標

解説

この関数は、この格子点の左上ピクセルの座標を取得します。

参照

SFXGrid::SetLeftTop

SFXGrid::GetRightBottom
この格子点の右下ピクセルの座標を取得します。
[ public, const ]
SFXPixel GetRightBottom(Void);

戻り値

この格子点の右下ピクセルの座標

解説

この関数は、この格子点の右下ピクセルの座標を取得します。

参照

SFXGrid::SetRightBottom

SFXGrid::GetRightTop
この格子点の右上ピクセルの座標を取得します。
[ public, const ]
SFXPixel GetRightTop(Void);

戻り値

この格子点の右上ピクセルの座標

解説

この関数は、この格子点の右上ピクセルの座標を取得します。

参照

SFXGrid::SetRightTop

SFXGrid::GetX
この格子点の X 座標を取得します。
[ public, const ]
SInt16 GetX(Void);

戻り値

この格子点の X 座標

解説

この関数は、この格子点の X 座標を取得します。

参照

SFXGrid::SetX | SFXGrid::GetY

SFXGrid::GetY
この格子点の Y 座標を取得します。
[ public, const ]
SInt16 GetY(Void);

戻り値

この格子点の Y 座標

解説

この関数は、この格子点の Y 座標を取得します。

参照

SFXGrid::SetY | SFXGrid::GetX

SFXGrid::IsInsideOf
この格子点の座標が指定された矩形領域の中に含まれるか判定します。
[ public, const ]
Bool IsInsideOf(
    SFXRectangleConstRef param   // 基準となる矩形領域
);

戻り値

  • 含まれるとき: true
  • そうでないとき: false

解説

この関数は、この格子点の座標が指定された矩形領域の中に含まれるか判定します。

[Note] 注意

矩形領域は辺の上も含みます。

SFXGrid::Mod
この格子点の座標を指定された値で剰余します。
[ public ]
SFXGridRef Mod(
    SInt16 x   // この格子点の X 座標を剰余する値
    SInt16 y   // この格子点の Y 座標を剰余する値
);
[ public ]
SFXGridRef Mod(
    SInt16 param   // この格子点の座標を剰余する値
);

戻り値

この格子点の座標を指定された値で剰余した後のこの格子点の座標

解説

この関数は、この格子点の座標を指定された値で剰余します。

x、y、または param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で剰余した分だけ移動します。

参照

SFXGrid::ModX | SFXGrid::ModY | SFXGrid::Div | SFXGrid::Add | SFXGrid::Sub | SFXGrid::Mul | SFXGrid::Neg | operator% | SFXGrid::operator%=

SFXGrid::ModX
この格子点の X 座標を指定された値で剰余します。
[ public ]
SFXGridRef ModX(
    SInt16 param   // 剰余する値
);

戻り値

この格子点の X 座標を指定された値で剰余した後のこの格子点の座標

解説

この関数は、この格子点の X 座標を指定された値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で剰余した分だけ移動します。

参照

SFXGrid::Mod | SFXGrid::ModY | SFXGrid::AddX | SFXGrid::SubX | SFXGrid::MulX | SFXGrid::DivX | SFXGrid::NegX

SFXGrid::ModY
この格子点の Y 座標を指定された値で剰余します。
[ public ]
SFXGridRef ModY(
    SInt16 param   // 剰余する値
);

戻り値

この格子点の Y 座標を指定された値で剰余した後のこの格子点の座標

解説

この関数は、この格子点の Y 座標を指定された値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で剰余した分だけ移動します。

参照

SFXGrid::Mod | SFXGrid::ModX | SFXGrid::AddY | SFXGrid::SubY | SFXGrid::MulY | SFXGrid::DivY | SFXGrid::NegY

SFXGrid::Mul
この格子点の座標に指定された値を乗算します。
[ public ]
SFXGridRef Mul(
    SInt16 x   // この格子点の X 座標に乗算する値
    SInt16 y   // この格子点の Y 座標に乗算する値
);
[ public ]
SFXGridRef Mul(
    SInt16 param   // この格子点の座標に乗算する値
);

戻り値

この格子点の座標に指定された値を乗算した後のこの格子点の座標

解説

この関数は、この格子点の座標に指定された値を乗算します。

[Note] 注意

この格子点の座標は指定された値で乗算した分だけ移動します。

参照

SFXGrid::MulX | SFXGrid::MulY | SFXGrid::Add | SFXGrid::Sub | SFXGrid::Div | SFXGrid::Mod | SFXGrid::Neg | operator* | SFXGrid::operator*=

SFXGrid::MulX
この格子点の X 座標に指定された値を乗算します。
[ public ]
SFXGridRef MulX(
    SInt16 param   // 乗算する値
);

戻り値

この格子点の X 座標に指定された値を乗算した後のこの格子点の座標

解説

この関数は、この格子点の X 座標に指定された値を乗算します。

[Note] 注意

この格子点の座標は指定された値で乗算した分だけ移動します。

参照

SFXGrid::Mul | SFXGrid::MulY | SFXGrid::AddX | SFXGrid::SubX | SFXGrid::DivX | SFXGrid::ModX | SFXGrid::NegX

SFXGrid::MulY
この格子点の Y 座標に指定された値を乗算します。
[ public ]
SFXGridRef MulY(
    SInt16 param   // 乗算する値
);

戻り値

この格子点の Y 座標に指定された値を乗算した後のこの格子点の座標

解説

この関数は、この格子点の Y 座標に指定された値を乗算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

この格子点の座標は指定された値で乗算した分だけ移動します。

参照

SFXGrid::Mul | SFXGrid::MulX | SFXGrid::AddY | SFXGrid::SubY | SFXGrid::DivY | SFXGrid::ModY | SFXGrid::NegY

SFXGrid::Neg
この格子点の座標の符号を反転します。
[ public ]
SFXGridRef Neg(Void);

戻り値

この格子点の座標（X 座標と Y 座標）の符号を反転させた後のこの格子点の座標

解説

この関数は、この格子点の座標（X 座標と Y 座標）の符号を反転します。

[Note] 注意

この格子点の座標は符号を反転させた分だけ移動します。

参照

SFXGrid::NegX | SFXGrid::NegY | SFXGrid::Add | SFXGrid::Sub | SFXGrid::Mul | SFXGrid::Div | SFXGrid::Mod

SFXGrid::NegX
この格子点の X 座標の符号を反転します。
[ public ]
SFXGridRef NegX(Void);

戻り値

この格子点の X 座標の符号を反転させた後のこの格子点の座標

解説

この関数は、この格子点の X 座標の符号を反転します。

[Note] 注意

この格子点の座標は符号を反転させた分だけ移動します。

参照

SFXGrid::Neg | SFXGrid::NegY | SFXGrid::AddX | SFXGrid::SubX | SFXGrid::MulX | SFXGrid::DivX | SFXGrid::ModX

SFXGrid::NegY
この格子点の Y 座標の符号を反転します。
[ public ]
SFXGridRef NegY(Void);

戻り値

この格子点の Y 座標の符号を反転させた後のこの格子点の座標

解説

この関数は、この格子点の Y 座標の符号を反転します。

[Note] 注意

この格子点の座標は符号を反転させた分だけ移動します。

参照

SFXGrid::Neg | SFXGrid::NegX | SFXGrid::AddY | SFXGrid::SubY | SFXGrid::MulY | SFXGrid::DivY | SFXGrid::ModY

SFXGrid::Set
この格子点の座標を指定された値に設定します。
[ public ]
SFXGridRef Set(
    SFXGridConstRef param   // コピー元の格子点
);
[ public ]
SFXGridRef Set(
    SInt16 x   // X 座標
    SInt16 y   // Y 座標
);
[ public ]
SFXGridRef Set(
    SFXSizeConstRef size   // 幅と高さ
);

戻り値

設定後のこの格子点の座標

解説

この関数は、この格子点の座標（X 座標と Y 座標）を指定された値に設定します。

[Note] 注意

指定された値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::operator=

SFXGrid::SetLeftBottom
左下ピクセルの座標を指定してこの格子点の座標を設定します。
[ public ]
SFXGridRef SetLeftBottom(
    SFXPixelConstRef param   // この格子点の左下ピクセルの座標
);
[ public ]
SFXGridRef SetLeftBottom(
    SInt16 x   // この格子点の左下ピクセルの X 座標
    SInt16 y   // この格子点の左下ピクセルの Y 座標
);

戻り値

設定後のこの格子点の座標

解説

この関数は、左下ピクセルの座標を指定してこの格子点の座標を設定します。

参照

SFXGrid::GetLeftBottom

SFXGrid::SetLeftTop
左上ピクセルの座標を指定してこの格子点の座標を設定します。
[ public ]
SFXGridRef SetLeftTop(
    SFXPixelConstRef param   // この格子点の左上ピクセルの座標
);
[ public ]
SFXGridRef SetLeftTop(
    SInt16 x   // この格子点の左上ピクセルの X 座標
    SInt16 y   // この格子点の左上ピクセルの Y 座標
);

戻り値

設定後のこの格子点の座標

解説

この関数は、左上ピクセルの座標を指定してこの格子点の座標を設定します。

参照

SFXGrid::GetLeftTop

SFXGrid::SetRightBottom
右下ピクセルの座標を指定してこの格子点の座標を設定します。
[ public ]
SFXGridRef SetRightBottom(
    SFXPixelConstRef param   // この格子点の右下ピクセルの座標
);
[ public ]
SFXGridRef SetRightBottom(
    SInt16 x   // この格子点の右下ピクセルの X 座標
    SInt16 y   // この格子点の右下ピクセルの Y 座標
);

戻り値

設定後のこの格子点の座標

解説

この関数は、右下ピクセルの座標を指定してこの格子点の座標を設定します。

参照

SFXGrid::GetRightBottom

SFXGrid::SetRightTop
右上ピクセルの座標を指定してこの格子点の座標を設定します。
[ public ]
SFXGridRef SetRightTop(
    SFXPixelConstRef param   // この格子点の右上ピクセルの座標
);
[ public ]
SFXGridRef SetRightTop(
    SInt16 x   // この格子点の右上ピクセルの X 座標
    SInt16 y   // この格子点の右上ピクセルの Y 座標
);

戻り値

設定後のこの格子点の座標

解説

この関数は、右上ピクセルの座標を指定してこの格子点の座標を設定します。

参照

SFXGrid::GetRightTop

SFXGrid::SetX
この格子点の X 座標を指定された値に設定します。
[ public ]
SFXGridRef SetX(
    SInt16 param   // 設定する値
);

戻り値

設定後のこの格子点の座標

解説

この関数は、この格子点の X 座標を指定された値に設定します。

参照

SFXGrid::GetX | SFXGrid::Set | SFXGrid::SetY

SFXGrid::SetY
この格子点の Y 座標を指定された値に設定します。
[ public ]
SFXGridRef SetY(
    SInt16 param   // 設定する値
);

戻り値

設定後のこの格子点の座標

解説

この関数は、この格子点の Y 座標を指定された値に設定します。

参照

SFXGrid::GetY | SFXGrid::Set | SFXGrid::SetX

SFXGrid::Sub
この格子点の座標から指定された値を減算します。
[ public ]
SFXGridRef Sub(
    SFXGridConstRef param   // この格子点の座標から減算する値
);
[ public ]
SFXGridRef Sub(
    SInt16 x   // この格子点の X 座標から減算する値
    SInt16 y   // この格子点の Y 座標から減算する値
);
[ public ]
SFXGridRef Sub(
    SFXSizeConstRef size   // この格子点の座標から減算する値
);

戻り値

この格子点の座標から指定された値を減算した後のこの格子点の座標

解説

この関数は、この格子点の座標から指定された値を減算します。

[Note] 注意

この格子点の座標は指定された値を減算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Add | SFXGrid::SubX | SFXGrid::SubY | SFXGrid::Mul | SFXGrid::Div | SFXGrid::Mod | SFXGrid::Neg | SFXGrid::operator-=

SFXGrid::SubX
この格子点の X 座標から指定された値を減算します。
[ public ]
SFXGridRef SubX(
    SInt16 param   // 減算する値
);

戻り値

この格子点の X 座標から指定された値を減算した後のこの格子点の座標

解説

この関数は、この格子点の X 座標から指定された値を減算します。

[Note] 注意

この格子点の座標は指定された値を減算した分だけ移動します。

参照

SFXGrid::AddX | SFXGrid::Sub | SFXGrid::SubY | SFXGrid::MulX | SFXGrid::DivX | SFXGrid::ModX | SFXGrid::NegX

SFXGrid::SubY
この格子点の Y 座標から指定された値を減算します。
[ public ]
SFXGridRef SubY(
    SInt16 param   // 減算する値
);

戻り値

この格子点の Y 座標から指定された値を減算した後のこの格子点の座標

解説

この関数は、この格子点の Y 座標から指定された値を減算します。

[Note] 注意

この格子点の座標は指定された値を減算した分だけ移動します。

参照

SFXGrid::AddY | SFXGrid::Sub | SFXGrid::SubX | SFXGrid::MulY | SFXGrid::DivY | SFXGrid::ModY | SFXGrid::NegY

SFXGrid::ZeroInstance
0 を表す SFXGrid インスタンスを取得します。
[ public, static ]
SFXGridConstRef ZeroInstance(Void);

戻り値

0 を表す SFXGrid インスタンス

解説

この関数は、0 を表す SFXGrid インスタンスを返します。

具体的には、 SFXGrid::AtomRec 構造体のメンバ変数である、 X 座標と Y 座標が 0 に設定された SFXGrid インスタンスを返します。

[Note] 0 を表すインスタンスとは

0 を表すインスタンスとは、 対応する AtomRec 構造体のすべてのメンバ変数が 0 または null に設定されたインスタンスのことです。

使用例

SFXGrid grid(10, 20);

grid = SFXGrid::ZeroInstance();  // grid を初期化する
TRACE("x = %d, y = %d", grid.GetX(), grid.GetY());  // x = 0, y = 0

参照

SFXGrid::AtomRec

atomic_cast
SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。
[ public, friend ]
SFXGrid::AtomRec * atomic_cast(
    SFXGrid * param   // キャストするグリッド座標
);
[ public, friend ]
SFXGrid::AtomRec const * atomic_cast(
    SFXGrid const * param   // キャストするグリッド座標
);

解説

この関数は、SFXGrid クラスを SFXGrid::AtomRec 構造体に型変換します。

参照

SFXGrid::AtomRec

interface_cast
SFXGrid クラスを AEEPoint 構造体に型変換します。
[ public, friend ]
AEEPoint * interface_cast(
    SFXGrid * param   // キャストする格子点
);
[ public, friend ]
AEEPoint const * interface_cast(
    SFXGrid const * param   // キャストする格子点
);

解説

この関数は、SFXGrid クラスを BREW API AEEPoint 構造体に型変換します。

参照

BREW API AEEPoint

SFXGrid::operator=
左側の格子点の座標に右側の値を代入します。
[ public ]
SFXGridRef operator=(
    SFXGridConstRef param   // コピー元の格子点
);
[ public ]
SFXGridRef operator=(
    SFXSizeConstRef size   // 幅と高さ
);

戻り値

右側の値を代入した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標に右側の値を代入します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Set

SFXGrid::operator/=
左側の格子点の座標を右側の値で除算します。
[ public ]
SFXGridRef operator/=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で除算した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

左側の格子点の座標は右側の値で除算した分だけ移動します。

参照

SFXGrid::Div | operator/ | SFXGrid::operator*= | SFXGrid::operator%=

operator/
左側の格子点の座標を右側の値で除算した格子点の座標を返します。
[ public, friend ]
SFXGrid operator/(
    SFXGridConstRef left   // 左側の格子点の座標
    SInt16 right           // 右側の値
);

戻り値

左側の格子点の座標を右側の値で除算した格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で除算した格子点の座標を返します。

right 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

戻り値の格子点の座標は、左側の格子点の座標よりも右側の値で除算した分だけ移動します。

参照

SFXGrid::Div | SFXGrid::operator/= | operator% | operator*

operator==
左側の格子点の座標が右側の値と等しいか判定します。
[ public, friend ]
Bool operator==(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXGridConstRef right   // 右側の格子点の座標
);
[ public, friend ]
Bool operator==(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXSizeConstRef right   // 右側のサイズ
);

戻り値

  • 等しいとき: true
  • そうでないとき: false

解説

このオペレーターは、左側の格子点の座標が右側の値と等しいか判定します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Equals | operator!=

SFXGrid::operator-=
左側の格子点の座標から右側の値を減算します。
[ public ]
SFXGridRef operator-=(
    SFXGridConstRef param   // 右側の格子点の座標
);
[ public ]
SFXGridRef operator-=(
    SFXSizeConstRef size   // 右側のサイズ
);

戻り値

右側の値を減算した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標から右側の値を減算します。

[Note] 注意

左側の格子点の座標は右側の値を減算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Sub | operator- | SFXGrid::operator+=

operator-
左側の格子点の座標から右側の値を減算した格子点の座標を返します。
[ public, const ]
SFXGrid operator-(Void);
[ public, friend ]
SFXGrid operator-(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXGridConstRef right   // 右側の格子点の座標
);
[ public, friend ]
SFXGrid operator-(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXSizeConstRef right   // 右側のサイズ
);

戻り値

左側の格子点の座標から右側の値を減算した格子点の座標

解説

このオペレーターは、左側の格子点の座標から右側の値を減算した格子点の座標を返します。

このオペレーターが単項演算子の場合は（operator- の引数が Void 型のとき）、 オペランドの格子点の座標（X 座標と Y 座標）の符号を反転させた座標を返します。

[Note] 注意

戻り値の格子点の座標は、左側の格子点の座標よりも右側の値を減算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Sub | SFXGrid::operator-= | operator+

SFXGrid::operator%=
左側の格子点の座標を右側の値で剰余します。
[ public ]
SFXGridRef operator%=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で剰余した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

左側の格子点の座標は右側の値で剰余した分だけ移動します。

参照

SFXGrid::Mod | operator% | SFXGrid::operator/= | SFXGrid::operator*=

operator%
左側の格子点の座標を右側の値で剰余した格子点の座標を返します。
[ public, friend ]
SFXGrid operator%(
    SFXGridConstRef left   // 左側の格子点の座標
    SInt16 right           // 右側の値
);

戻り値

左側の格子点の座標を右側の値で剰余した格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で剰余した格子点の座標を返します。

right 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

戻り値の格子点の座標は、左側の格子点の座標よりも右側の値で剰余した分だけ移動します。

参照

SFXGrid::Mod | SFXGrid::operator%= | operator/ | operator*

SFXGrid::operator*=
左側の格子点の座標を右側の値で乗算します。
[ public ]
SFXGridRef operator*=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で乗算した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で乗算します。

[Note] 注意

左側の格子点の座標は右側の値で乗算した分だけ移動します。

参照

SFXGrid::Mul | operator* | SFXGrid::operator/= | SFXGrid::operator%=

operator*
左側の格子点の座標を右側の値で乗算した格子点の座標を返します。
[ public, friend ]
SFXGrid operator*(
    SFXGridConstRef left   // 左側の格子点の座標
    SInt16 right           // 右側の値
);

戻り値

左側の格子点の座標を右側の値で乗算した格子点の座標

解説

このオペレーターは、左側の格子点の座標を右側の値で乗算した格子点の座標を返します。

[Note] 注意

戻り値の格子点の座標は、左側の格子点の座標よりも右側の値で乗算した分だけ移動します。

参照

SFXGrid::Mul | SFXGrid::operator*= | operator/ | operator%

operator!=
左側の格子点の座標が右側の値と異なるか判定します。
[ public, friend ]
Bool operator!=(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXGridConstRef right   // 右側の格子点の座標
);
[ public, friend ]
Bool operator!=(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXSizeConstRef right   // 右側のサイズ
);

戻り値

  • 異なるとき: true
  • そうでないとき: false

解説

このオペレーターは、左側の格子点の座標が右側の値と異なるか判定します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Equals | operator==

SFXGrid::operator+=
左側の格子点の座標に右側の値を加算します。
[ public ]
SFXGridRef operator+=(
    SFXGridConstRef param   // 右側の格子点の座標
);
[ public ]
SFXGridRef operator+=(
    SFXSizeConstRef size   // 右側のサイズ
);

戻り値

右側の値を加算した後の左側の格子点の座標

解説

このオペレーターは、左側の格子点の座標に右側の値を加算します。

[Note] 注意

左側の格子点の座標は右側の値を加算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Add | operator+ | SFXGrid::operator-=

operator+
左側の格子点の座標に右側の値を加算した格子点の座標を返します。
[ public, const ]
SFXGrid operator+(Void);
[ public, friend ]
SFXGrid operator+(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXGridConstRef right   // 右側の格子点の座標
);
[ public, friend ]
SFXGrid operator+(
    SFXGridConstRef left    // 左側の格子点の座標
    SFXSizeConstRef right   // 右側のサイズ
);

戻り値

左側の格子点の座標に右側の値を加算した格子点の座標

解説

このオペレーターは、左側の格子点の座標に右側の値を加算した格子点の座標を返します。

このオペレーターが単項演算子の場合は（operator+ の引数が Void 型のとき）、オペランドの格子点の座標をそのまま返します。

[Note] 注意

戻り値の格子点の座標は、左側の格子点の座標よりも右側の値を加算した分だけ移動します。

[Note] 注意

右側の値が SFXSize クラスの場合、 SFXSize クラスの幅と高さをそれぞれ SFXGrid クラスの X 座標と Y 座標と解釈します。

参照

SFXGrid::Add | operator- | SFXGrid::operator+=

SFXGrid::AtomRec
格子点を表す構造体です。 
struct AtomRec {
  SInt16  x;  // X 座標
  SInt16  y;  // Y 座標
};

参照

BREW API AEEPoint

Copyright(c) 2002 - 2024
Sophia Cradle Incorporated
All Rights Reserved. 		前のページ次のページ上に戻るホーム