前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXClip
クリッピング領域を表すクラスです。
#include <SFXClip.h.hpp>
class SFXClip;
SFMTYPEDEFCLASS(SFXClip)

協調図

SFXClip クラスの協調図

解説

SFXClip クラスは、 クリッピング領域を処理するためのクラスです。

SFXClip::AtomRec 構造体はクリッピング領域を表す構造体であり、 クリッピング領域の形状とその領域を持ちます。

クリッピング領域の形状として、 円(SFXCircle)、 楕円(SFXEllipse)、 扇形(SFXPie)、 多角形(SFXPolygon)、 三角形(SFXTriangle)、または矩形(SFXRectangle) を指定できます。

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

参照

SFXClip::AtomRec | SFXCircle | SFXEllipse | SFXPie | SFXPolygon | SFXTriangle | SFXRectangle | BREW API AEEClip

メンバ

コンストラクタ/デストラクタ
SFXClip( Void )
SFXClip クラスのコンストラクタです。
SFXClip( SFXClipConstRef param )
SFXClip クラスのコンストラクタです。
SFXClip( SFXRectangleConstRef rectangle )
SFXClip クラスのコンストラクタです。
SFXClip( SFXCircleConstRef circle )
SFXClip クラスのコンストラクタです。
SFXClip( SFXEllipseConstRef ellipse )
SFXClip クラスのコンストラクタです。
SFXClip( SFXPieConstRef pie )
SFXClip クラスのコンストラクタです。
SFXClip( SFXTriangleConstRef triangle )
SFXClip クラスのコンストラクタです。
SFXClip( SFXPolygonConstRef polygon )
SFXClip クラスのコンストラクタです。
パブリック関数
static
SFXClipConstRef
EmptyInstance( Void )
空のクリッピング領域を取得します。
Bool Equals( SFXClipConstRef param )
このクリッピング領域が指定されたクリッピング領域と等しいか判定します。
SFXCircleConstRef GetCircle( Void )
このクリッピング領域(形状:円)を取得します。
SFXEllipseConstRef GetEllipse( Void )
このクリッピング領域(形状:楕円)を取得します。
SFXPieConstRef GetPie( Void )
このクリッピング領域(形状:扇形)を取得します。
SFXPolygonConstRef GetPolygon( Void )
このクリッピング領域(形状:多角形)を取得します。
SFXRectangleConstRef GetRectangle( Void )
このクリッピング領域(形状:矩形)を取得します。
SFXTriangleConstRef GetTriangle( Void )
このクリッピング領域(形状:三角形)を取得します。
AEEClipShape GetType( Void )
このクリッピング領域の形状を取得します。
Bool IsCircle( Void )
このクリッピング領域の形状が円であるか判定します。
Bool IsEllipse( Void )
このクリッピング領域の形状が楕円であるか判定します。
Bool IsEmpty( Void )
このクリッピング領域が空であるか判定します。
Bool IsNone( Void )
このクリッピング領域の形状が未設定であるか判定します。
Bool IsPie( Void )
このクリッピング領域の形状が扇形であるか判定します。
Bool IsPolygon( Void )
このクリッピング領域の形状が多角形であるか判定します。
Bool IsRectangle( Void )
このクリッピング領域の形状が矩形であるか判定します。
Bool IsTriangle( Void )
このクリッピング領域の形状が三角形であるか判定します。
static
SFXClipConstRef
NoneInstance( Void )
クリッピング領域の形状が未設定であり、面積が 0 である SFXClip インスタンスを取得します。
SFXClipRef Normalize( Void )
このクリッピング領域を正規化します。
SFXClipRef Offset( SFXGridConstRef param )
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標に指定された値を加算し、このクリッピング領域を移動します。
SFXClipRef Offset( SInt16 x , SInt16 y )
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標に指定された値を加算し、このクリッピング領域を移動します。
SFXClipRef Set( SFXClipConstRef param )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXRectangleConstRef rectangle )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXCircleConstRef circle )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXEllipseConstRef ellipse )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXPieConstRef pie )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXTriangleConstRef triangle )
このクリッピング領域を指定された値に設定します。
SFXClipRef Set( SFXPolygonConstRef polygon )
このクリッピング領域を指定された値に設定します。
SFXClipRef SetNone( Void )
このクリッピング領域の形状を未設定に設定します。
SFXClipRef Unoffset( SFXGridConstRef param )
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標から指定された値を減算し、このクリッピング領域を移動します。
SFXClipRef Unoffset( SInt16 x , SInt16 y )
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標から指定された値を減算し、このクリッピング領域を移動します。
SFXClipRef operator+=( SFXGridConstRef param )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動します。
SFXClipRef operator-=( SFXGridConstRef param )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動します。
SFXClipRef operator=( SFXClipConstRef param )
左側のクリッピング領域に右側のクリッピング領域を代入します。
SFXClip::AtomRec * atomic_cast( SFXClip * param )
SFXClip クラスを SFXClip::AtomRec 構造体に型変換します。
SFXClip::AtomRec const * atomic_cast( SFXClip const * param )
SFXClip クラスを SFXClip::AtomRec 構造体に型変換します。
AEEClip * interface_cast( SFXClip * param )
SFXClip クラスを AEEClip 構造体に型変換します。
AEEClip const * interface_cast( SFXClip const * param )
SFXClip クラスを AEEClip 構造体に型変換します。
Bool operator==( SFXClipConstRef left , SFXClipConstRef right )
左側のクリッピング領域が右側のクリッピング領域と等しいか判定します。
SFXClip operator-( SFXClipConstRef left , SFXGridConstRef right )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動したクリッピング領域を返します。
Bool operator!=( SFXClipConstRef left , SFXClipConstRef right )
左側のクリッピング領域が右側のクリッピング領域と異なるか判定します。
SFXClip operator+( SFXClipConstRef left , SFXGridConstRef right )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動したクリッピング領域を返します。
AtomRec
クリッピング領域を表す構造体です。
グローバル関数
SFXClip::AtomRec * atomic_cast( SFXClip * param )
SFXClip クラスを SFXClip::AtomRec 構造体に型変換します。
SFXClip::AtomRec const * atomic_cast( SFXClip const * param )
SFXClip クラスを SFXClip::AtomRec 構造体に型変換します。
AEEClip * interface_cast( SFXClip * param )
SFXClip クラスを AEEClip 構造体に型変換します。
AEEClip const * interface_cast( SFXClip const * param )
SFXClip クラスを AEEClip 構造体に型変換します。
Bool operator==( SFXClipConstRef left , SFXClipConstRef right )
左側のクリッピング領域が右側のクリッピング領域と等しいか判定します。
SFXClip operator-( SFXClipConstRef left , SFXGridConstRef right )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動したクリッピング領域を返します。
Bool operator!=( SFXClipConstRef left , SFXClipConstRef right )
左側のクリッピング領域が右側のクリッピング領域と異なるか判定します。
SFXClip operator+( SFXClipConstRef left , SFXGridConstRef right )
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動したクリッピング領域を返します。

SFXClip::SFXClip
SFXClip クラスのコンストラクタです。
[ public, explicit ]
SFXClip(Void);
[ public ]
SFXClip(
    SFXClipConstRef param   // 元になるクリッピング領域
);
[ public, explicit ]
SFXClip(
    SFXRectangleConstRef rectangle   // 元になる矩形
);
[ public, explicit ]
SFXClip(
    SFXCircleConstRef circle   // 元になる円
);
[ public, explicit ]
SFXClip(
    SFXEllipseConstRef ellipse   // 元になる楕円
);
[ public, explicit ]
SFXClip(
    SFXPieConstRef pie   // 元になる扇形
);
[ public, explicit ]
SFXClip(
    SFXTriangleConstRef triangle   // 元になる三角形
);
[ public, explicit ]
SFXClip(
    SFXPolygonConstRef polygon   // 元になる多角形
);

解説

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

参照

SFXClip::Set | SFXRectangle | SFXCircle | SFXEllipse | SFXPie | SFXTriangle | SFXPolygon | BREW API AEEClip


SFXClip::EmptyInstance
空のクリッピング領域を取得します。
[ public, static ]
SFXClipConstRef EmptyInstance(Void);

参照

SFXClip::NoneInstance | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::Equals
このクリッピング領域が指定されたクリッピング領域と等しいか判定します。
[ public, const ]
Bool Equals(
    SFXClipConstRef param   // 比較対象のクリッピング領域
);

戻り値

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

解説

この関数は、このクリッピング領域が指定されたクリッピング領域と等しいか判定します。

参照

operator== | operator!=


SFXClip::GetCircle
このクリッピング領域(形状:円)を取得します。
[ public, const ]
SFXCircleConstRef GetCircle(Void);

戻り値

このクリッピング領域(形状:円)

解説

この関数は、このクリッピング領域(形状:円)を取得します。

[Note] 注意

このクリッピング領域が円でない場合の動作は未定義です。

参照

SFXCircle | SFXClip::Set | SFXClip::GetEllipse | SFXClip::GetPie | SFXClip::GetPolygon | SFXClip::GetRectangle | SFXClip::GetTriangle | SFXClip::GetType


SFXClip::GetEllipse
このクリッピング領域(形状:楕円)を取得します。
[ public, const ]
SFXEllipseConstRef GetEllipse(Void);

戻り値

このクリッピング領域(形状:楕円)

解説

この関数は、このクリッピング領域(形状:楕円)を取得します。

[Note] 注意

このクリッピング領域が楕円でない場合の動作は未定義です。

参照

SFXEllipse | SFXClip::Set | SFXClip::GetCircle | SFXClip::GetPie | SFXClip::GetPolygon | SFXClip::GetRectangle | SFXClip::GetTriangle | SFXClip::GetType


SFXClip::GetPie
このクリッピング領域(形状:扇形)を取得します。
[ public, const ]
SFXPieConstRef GetPie(Void);

戻り値

このクリッピング領域(形状:扇形)

解説

この関数は、このクリッピング領域(形状:扇形)を取得します。

[Note] 注意

このクリッピング領域が扇形でない場合の動作は未定義です。

参照

SFXPie | SFXClip::Set | SFXClip::GetCircle | SFXClip::GetEllipse | SFXClip::GetPolygon | SFXClip::GetRectangle | SFXClip::GetTriangle | SFXClip::GetType


SFXClip::GetPolygon
このクリッピング領域(形状:多角形)を取得します。
[ public, const ]
SFXPolygonConstRef GetPolygon(Void);

戻り値

このクリッピング領域(形状:多角形)

解説

この関数は、このクリッピング領域(形状:多角形)を取得します。

[Note] 注意

このクリッピング領域が多角形でない場合の動作は未定義です。

参照

SFXPolygon | SFXClip::Set | SFXClip::GetCircle | SFXClip::GetEllipse | SFXClip::GetPie | SFXClip::GetRectangle | SFXClip::GetTriangle | SFXClip::GetType


SFXClip::GetRectangle
このクリッピング領域(形状:矩形)を取得します。
[ public, const ]
SFXRectangleConstRef GetRectangle(Void);

戻り値

このクリッピング領域(形状:矩形)

解説

この関数は、このクリッピング領域(形状:矩形)を取得します。

[Note] 注意

このクリッピング領域が矩形でない場合の動作は未定義です。

参照

SFXRectangle | SFXClip::Set | SFXClip::GetCircle | SFXClip::GetEllipse | SFXClip::GetPie | SFXClip::GetPolygon | SFXClip::GetTriangle | SFXClip::GetType


SFXClip::GetTriangle
このクリッピング領域(形状:三角形)を取得します。
[ public, const ]
SFXTriangleConstRef GetTriangle(Void);

戻り値

このクリッピング領域(形状:三角形)

解説

この関数は、このクリッピング領域(形状:三角形)を取得します。

[Note] 注意

このクリッピング領域が三角形でない場合の動作は未定義です。

参照

SFXTriangle | SFXClip::Set | SFXClip::GetCircle | SFXClip::GetEllipse | SFXClip::GetPie | SFXClip::GetPolygon | SFXClip::GetRectangle | SFXClip::GetType


SFXClip::GetType
このクリッピング領域の形状を取得します。
[ public, const ]
AEEClipShape GetType(Void);

戻り値

このクリッピング領域の形状に応じて以下の値を返します(参照: BREW API AEEClipShape)。

意味
CLIPPING_NONE 形状未設定
CLIPPING_CIRCLE
CLIPPING_ELLIPSE 楕円
CLIPPING_PIE 扇形
CLIPPING_POLYGON 多角形
CLIPPING_TRIANGLE 三角形
CLIPPING_RECT 矩形

解説

この関数は、このクリッピング領域の形状を取得します。

参照

SFXClip::Set | SFXClip::GetCircle | SFXClip::GetEllipse | SFXClip::GetPie | SFXClip::GetPolygon | SFXClip::GetRectangle | SFXClip::GetTriangle | BREW API AEEClipShape


SFXClip::IsCircle
このクリッピング領域の形状が円であるか判定します。
[ public, const ]
Bool IsCircle(Void);

戻り値

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

解説

この関数は、このクリッピング領域の形状が円であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が円(CLIPPING_CIRCLE)のとき、 ture を返します。

参照

SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsEllipse
このクリッピング領域の形状が楕円であるか判定します。
[ public, const ]
Bool IsEllipse(Void);

戻り値

  • 楕円であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が楕円であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が楕円(CLIPPING_ELLIPSE)のとき、 ture を返します。

参照

SFXClip::IsCircle | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsEmpty
このクリッピング領域が空であるか判定します。
[ public, const ]
Bool IsEmpty(Void);

戻り値

  • 空のとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域が空であるか(面積が 0 であるか)判定します。

SFXClip::AtomRec 構造体のメンバ変数である、 このクリッピング領域の形状(円・楕円・扇形・多角形・三角形・矩形)に応じてその領域が空のとき、 true を返します。

具体的には、 SFXClip::AtomRec 構造体のクリッピング領域の形状に応じてそれぞれの IsEmpty 関数を呼び出してこのクリッピング領域が空であるか判定します。

ただし、クリッピング領域の形状が未設定(CLIPPING_NONE)のときは、false が返ります。

参照

SFXRectangle::IsEmpty | SFXCircle::IsEmpty | SFXEllipse::IsEmpty | SFXPie::IsEmpty | SFXTriangle::IsEmpty | SFXPolygon::IsEmpty | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsNone
このクリッピング領域の形状が未設定であるか判定します。
[ public, const ]
Bool IsNone(Void);

戻り値

  • 未設定であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が未設定であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が未設定(CLIPPING_NONE)のとき、 ture を返します。

参照

SFXClip::GetType | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsPie
このクリッピング領域の形状が扇形であるか判定します。
[ public, const ]
Bool IsPie(Void);

戻り値

  • 扇形であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が扇形であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が扇形(CLIPPING_PIE)のとき、 ture を返します。

参照

SFXPie | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsPolygon
このクリッピング領域の形状が多角形であるか判定します。
[ public, const ]
Bool IsPolygon(Void);

戻り値

  • 多角形であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が多角形であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が多角形(CLIPPING_POLYGON)のとき、 ture を返します。

参照

SFXPolygon | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsRectangle | SFXClip::IsTriangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsRectangle
このクリッピング領域の形状が矩形であるか判定します。
[ public, const ]
Bool IsRectangle(Void);

戻り値

  • 矩形であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が矩形であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が矩形(CLIPPING_RECT)のとき、 ture を返します。

参照

SFXRectangle | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsTriangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::IsTriangle
このクリッピング領域の形状が三角形であるか判定します。
[ public, const ]
Bool IsTriangle(Void);

戻り値

  • 三角形であるとき: true
  • そうでないとき: false

解説

この関数は、このクリッピング領域の形状が三角形であるか判定します。

[Note] 注意

SFXClip::AtomRec 構造体のクリッピング領域の形状が三角形(CLIPPING_TRIANGLE)のとき、 ture を返します。

参照

SFXTriangle | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::NoneInstance
クリッピング領域の形状が未設定であり、面積が 0 である SFXClip インスタンスを取得します。
[ public, static ]
SFXClipConstRef NoneInstance(Void);

戻り値

クリッピング領域の形状が未設定(CLIPPING_NONE)であり、面積が 0 である SFXClip インスタンス

解説

この関数は、SFXClip::AtomRec 構造体のクリッピング領域の形状が未設定(CLIPPING_NONE)であり、 その面積が 0 である SFXClip インスタンスを取得します。

[Caution] 注意

SFXClip::EmptyInstance 関数の戻り値のクリッピング領域の形状は、 長方形(CLIPPING_RECT)です。

参照

SFXClip::EmptyInstance | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::Normalize
このクリッピング領域を正規化します。
[ public ]
SFXClipRef Normalize(Void);

戻り値

正規化されたこのクリッピング領域

解説

この関数は、このクリッピング領域を正規化します。

具体的には、 SFXClip::AtomRec 構造体のクリッピング領域の形状に応じて、 それぞれの Normalize 関数を呼び出してこのクリッピング領域が有効な面積を持つようにします。

使用例

SFXClip clip;
SFXRectangle rect(10, 10, -50, 50);  

clip.Set(rect);       // クリッピング領域を矩形に設定する
  
if(clip.IsEmpty()){   // クリッピング領域が空であるか確認する
                      // 幅が 0 以下なので true が返る

    clip.Normalize(); // クリッピング領域を正規化する

}

参照

SFXRectangle::Normalize | SFXCircle::Normalize | SFXEllipse::Normalize | SFXPie::Normalize | SFXTriangle::Normalize | SFXPolygon::Normalize | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::Offset
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標に指定された値を加算し、このクリッピング領域を移動します。
[ public ]
SFXClipRef Offset(
    SFXGridConstRef param   // 中心座標、開始点、またはすべての頂点の座標に加算する値
);
[ public ]
SFXClipRef Offset(
    SInt16 x   // 中心座標、開始点、またはすべての頂点の X 座標に加算する値
    SInt16 y   // 中心座標、開始点、またはすべての頂点の Y 座標に加算する値
);

戻り値

移動後のこのクリッピング領域

解説

この関数は、このクリッピング領域の中心座標、開始点、 またはすべての頂点の座標に指定された値を加算し、このクリッピング領域を移動します。

具体的には、 SFXClip::AtomRec 構造体のクリッピング領域の形状に応じてそれぞれの Offset 関数を呼び出してこのクリッピング領域を移動します。

参照

SFXClip::Unoffset | SFXRectangle::Offset | SFXCircle::Offset | SFXEllipse::Offset | SFXPie::Offset | SFXTriangle::Offset | SFXPolygon::Offset | operator+ | SFXClip::operator+= | operator- | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::Set
このクリッピング領域を指定された値に設定します。
[ public ]
SFXClipRef Set(
    SFXClipConstRef param   // コピー元のクリッピング領域
);
[ public ]
SFXClipRef Set(
    SFXRectangleConstRef rectangle   // コピー元の矩形
);
[ public ]
SFXClipRef Set(
    SFXCircleConstRef circle   // コピー元の円
);
[ public ]
SFXClipRef Set(
    SFXEllipseConstRef ellipse   // コピー元の楕円
);
[ public ]
SFXClipRef Set(
    SFXPieConstRef pie   // コピー元の扇形
);
[ public ]
SFXClipRef Set(
    SFXTriangleConstRef triangle   // コピー元の三角形
);
[ public ]
SFXClipRef Set(
    SFXPolygonConstRef polygon   // コピー元の多角形
);

戻り値

設定後のこのクリッピング領域

解説

この関数は、このクリッピング領域を指定された値に設定します。

具体的には、 SFXClip::AtomRec 構造体のクリッピング領域の形状を設定し、 その形状に応じてそれぞれの Set 関数を呼び出してこのクリッピング領域を設定します。

参照

SFXRectangle | SFXCircle | SFXEllipse | SFXPie | SFXTriangle | SFXPolygon | SFXRectangle::Set | SFXCircle::Set | SFXEllipse::Set | SFXPie::Set | SFXTriangle::Set | SFXPolygon::Set | SFXClip::operator= | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::SetNone
このクリッピング領域の形状を未設定に設定します。
[ public ]
SFXClipRef SetNone(Void);

戻り値

設定後のこのクリッピング領域

解説

この関数は、このクリッピング領域を未設定(CLIPPING_NONE)に設定します。

参照

SFXClip::Set | SFXClip::AtomRec | BREW API AEEClipShape


SFXClip::Unoffset
このクリッピング領域の中心座標、開始点、またはすべての頂点の座標から指定された値を減算し、このクリッピング領域を移動します。
[ public ]
SFXClipRef Unoffset(
    SFXGridConstRef param   // 中心座標、開始点、またはすべての頂点の座標から減算する値
);
[ public ]
SFXClipRef Unoffset(
    SInt16 x   // 中心座標、開始点、またはすべての頂点の X 座標から減算する値
    SInt16 y   // 中心座標、開始点、またはすべての頂点の Y 座標から減算する値
);

戻り値

移動後のこのクリッピング領域

解説

この関数は、このクリッピング領域の中心座標、開始点、 またはすべての頂点の座標から指定された値を減算し、このクリッピング領域を移動します。

具体的には、 SFXClip::AtomRec 構造体のクリッピング領域の形状に応じてそれぞれの Unoffset 関数を呼び出してこのクリッピング領域を移動します。

参照

SFXClip::Offset | SFXRectangle::Unoffset | SFXCircle::Unoffset | SFXEllipse::Unoffset | SFXPie::Unoffset | SFXTriangle::Unoffset | SFXPolygon::Unoffset | operator- | SFXClip::operator-= | operator+ | SFXClip::AtomRec | BREW API AEEClipShape


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

解説

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

参照

SFXClip::AtomRec


interface_cast
SFXClip クラスを AEEClip 構造体に型変換します。
[ public, friend ]
AEEClip * interface_cast(
    SFXClip * param   // キャストするクリッピング領域
);
[ public, friend ]
AEEClip const * interface_cast(
    SFXClip const * param   // キャストするクリッピング領域
);

解説

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

参照

BREW API AEEClip


SFXClip::operator=
左側のクリッピング領域に右側のクリッピング領域を代入します。
[ public ]
SFXClipRef operator=(
    SFXClipConstRef param   // 右側のクリッピング領域
);

戻り値

右側のクリッピング領域を代入した後の左側のクリッピング領域

解説

このオペレーターは、左側のクリッピング領域に右側のクリッピング領域を代入します。

参照

SFXClip::Set


operator==
左側のクリッピング領域が右側のクリッピング領域と等しいか判定します。
[ public, friend ]
Bool operator==(
    SFXClipConstRef left    // 左側のクリッピング領域
    SFXClipConstRef right   // 右側のクリッピング領域
);

戻り値

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

解説

このオペレーターは、左側のクリッピング領域が右側のクリッピング領域と等しいか判定します。

参照

SFXClip::Equals | operator!=


SFXClip::operator-=
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動します。
[ public ]
SFXClipRef operator-=(
    SFXGridConstRef param   // 右側の格子点の座標
);

戻り値

移動後のこのクリッピング領域

解説

このオペレーターは、左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動します。

[Note] 注意

このオペレーター実行後、左側のクリッピング領域は移動します。

参照

SFXClip::Unoffset | operator- | SFXClip::operator+=


operator-
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動したクリッピング領域を返します。
[ public, friend ]
SFXClip operator-(
    SFXClipConstRef left    // 左側のクリッピング領域
    SFXGridConstRef right   // 右側の格子点の座標
);

戻り値

左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動したクリッピング領域

解説

このオペレーターは、左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標から右側の格子点の座標を減算して移動したクリッピング領域を返します。

[Note] 注意

このオペレーター実行後、左側のクリッピング領域は移動しません。

参照

SFXClip::Unoffset | SFXClip::operator-= | operator+


operator!=
左側のクリッピング領域が右側のクリッピング領域と異なるか判定します。
[ public, friend ]
Bool operator!=(
    SFXClipConstRef left    // 左側のクリッピング領域
    SFXClipConstRef right   // 右側のクリッピング領域
);

戻り値

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

解説

このオペレーターは、左側のクリッピング領域が右側のクリッピング領域と異なるか判定します。

参照

SFXClip::Equals | operator==


SFXClip::operator+=
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動します。
[ public ]
SFXClipRef operator+=(
    SFXGridConstRef param   // 右側の格子点の座標
);

戻り値

移動後のこのクリッピング領域

解説

このオペレーターは、左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動します。

[Note] 注意

このオペレーター実行後、左側のクリッピング領域は移動します。

参照

SFXClip::Offset | SFXClip::operator-= | operator+


operator+
左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動したクリッピング領域を返します。
[ public, friend ]
SFXClip operator+(
    SFXClipConstRef left    // 左側のクリッピング領域
    SFXGridConstRef right   // 右側の格子点の座標
);

戻り値

左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動したクリッピング領域

解説

このオペレーターは、左側のクリッピング領域の中心座標、開始点、またはすべての頂点の座標に右側の格子点の座標を加算して移動したクリッピング領域を返します。

[Note] 注意

このオペレーター実行後、左側のクリッピング領域は移動しません。

参照

SFXClip::Offset | operator- | SFXClip::operator+=


SFXClip::AtomRec
クリッピング領域を表す構造体です。
struct AtomRec {
  AEEClipShape type;                   クリッピング領域の形状
  union {
    SFXRectangle::AtomRec  rectangle;  矩形
    SFXCircle::AtomRec     circle;     
    SFXEllipse::AtomRec    ellipse;    楕円
    SFXPie::AtomRec        pie;        扇形
    SFXTriangle::AtomRec   triangle;   三角形
    SFXPolygon::AtomRec    polygon;    多角形
  };
};

参照

BREW API AEEClipShape