SFUClip

クリッピング領域を表すクラスです。

#include <SFUClip.hpp>

class SFUClip : public AEEClip;

typedef SFUClip&          SFUClipRef;
typedef SFUClip*          SFUClipPtr;
typedef SFUClip**         SFUClipHandle;
typedef const SFUClip     ConstSFUClip;
typedef const SFUClip&    ConstSFUClipRef;
typedef const SFUClip*    ConstSFUClipPtr;
typedef const SFUClip**   ConstSFUClipHandle;

解説

SFUClip はクリッピング領域を表すクラスです。クリッピング領域を操作するためのさまざまな関数が用意されています。

メンバ

コンストラクタ/デストラクタ
public	SFUClip	SFUClip クラスのコンストラクタです。
public	~SFUClip	SFUClip クラスのデストラクタです。

パブリック関数
public	Clear	クリッピング領域を消去します。
public	Equal	2 つのクリッピング領域が等しいか判定します。
public	Offset	クリッピング領域を移動します。
public	Set	クリッピング領域を設定します。
public	operator+	クリッピング領域を移動します。
public	operator-	クリッピング領域を逆移動します。
public	operator==	2 つのクリッピング領域が等しいか判定します。

SFUClip::SFUClip

SFUClip クラスのコンストラクタです。

[ public ]
SFUClip(Void);

[ public ]
SFUClip(
    ConstSFUClipRef clip   // コピー元のクリッピング領域
);

[ public ]
SFUClip(
    ConstAEEClipRef clip   // コピー元のクリッピング領域
);

[ public ]
SFUClip(
    ConstSFURectRef rect   // 長方形
);

[ public ]
SFUClip(
    ConstSFUCircleRef circle   // 円
);

[ public ]
SFUClip(
    ConstSFUEllipseRef ellipse   // 楕円
);

[ public ]
SFUClip(
    ConstSFUPieRef pie   // 扇形
);

[ public ]
SFUClip(
    ConstSFUTriangleRef tri   // 三角形
);

[ public ]
SFUClip(
    ConstSFUPolygonRef polygon   // 多角形
);

解説

SFUClip をデフォルトコンストラクタで構築した場合は、その形状と形状データは不定になります。その場合は、実際に使用する前に必ず Set 関数で形状と形状データを指定してください。

参照

SFUClip::Set

SFUClip::~SFUClip

SFUClip クラスのデストラクタです。

[ public ]
~SFUClip(Void);

SFUClip::Clear

クリッピング領域を消去します。

[ public ]
ConstSFUClipRef Clear(Void);

解説

この関数は Set(CLIPPING_NONE, NULL) を呼び出すのと同じです。

参照

SFUClip::Set

SFUClip::Equal

2 つのクリッピング領域が等しいか判定します。

[ public, const ]
Bool Equal(
    ConstSFUClipRef clip   // 比較対象のクリッピング領域
);

戻り値

2 つのクリッピング領域の形状と形状データが等しければ TRUE を返します。そうでなければ FALSE を返します。

参照

SFUClip::operator==

SFUClip::Offset

クリッピング領域を移動します。

[ public ]
ConstSFUClipRef Offset(
    SInt16 x   // X 方向の移動値
    SInt16 y   // Y 方向の移動値
);

[ public ]
ConstSFUClipRef Offset(
    ConstSFUPointRef vector   // 移動する方向
);

戻り値

自分自身を返します。

参照

SFUClip::operator+ | SFUClip::operator-

SFUClip::Set

クリッピング領域を設定します。

[ public ]
ConstSFUClipRef Set(
    ConstSFURectRef rect   // 長方形
);

[ public ]
ConstSFUClipRef Set(
    ConstSFUCircleRef circle   // 円
);

[ public ]
ConstSFUClipRef Set(
    ConstSFUEllipseRef ellipse   // 楕円
);

[ public ]
ConstSFUClipRef Set(
    ConstSFUPieRef pie   // 扇形
);

[ public ]
ConstSFUClipRef Set(
    ConstSFUTriangleRef tri   // 三角形
);

[ public ]
ConstSFUClipRef Set(
    ConstSFUPolygonRef polygon   // 多角形
);

戻り値

自分自身を返します。

解説

クリッピング領域として指定された形状を設定します。

使用例

*** 使用例 ***

SFURect rect(10, 10, 90, 90);
SFUCircle circle(20, 20, 5)
SFUClip clip;

// 長方形のクリッピング領域を設定します。
clip.Set(rect);

// 円形のクリッピング領域を設定します。
clip.Set(circle);

参照

AEEClipShape | SFUClip::SFUClip

SFUClip::operator==

2 つのクリッピング領域が等しいか判定します。

[ public, friend ]
Bool operator==(
    ConstSFUClipRef clip1   
    ConstSFUClipRef clip2   
);

[ public, friend ]
Bool operator!=(
    ConstSFUClipRef clip1   
    ConstSFUClipRef clip2   
);

戻り値

2 つのクリッピング領域の形状と形状データが等しければ TRUE を返します。そうでなければ FALSE を返します。

参照

SFUClip::Equal

SFUClip::operator-

クリッピング領域を逆移動します。

[ public, friend ]
SFUClip operator-(
    ConstSFUClipRef clip      // 逆移動するクリッピング領域
    ConstSFUPointRef vector   // 逆移動する方向
);

[ public ]
ConstSFUClipRef operator-=(
    ConstSFUPointRef vector   // 逆移動する方向
);

参照

SFUClip::Offset | SFUClip::operator+

SFUClip::operator+

クリッピング領域を移動します。

[ public, friend ]
SFUClip operator+(
    ConstSFUClipRef clip      // 移動するクリッピング領域
    ConstSFUPointRef vector   // 移動する方向
);

[ public ]
ConstSFUClipRef operator+=(
    ConstSFUPointRef vector   // 移動する方向
);

参照

SFUClip::Offset | SFUClip::operator-