前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework UNIVERSE 5.0
SFXClip
クリッピング領域を表すクラスです。
#include <SFXClip.h.hpp>
class SFXClip;
SFMTYPEDEFCLASS(SFXClip)

協調図

SFXClip クラスの協調図

解説

SFXClip クラスはクリッピング領域に関する処理を行う関数を持ちます。

参照

BREW API AEEClip

メンバ

コンストラクタ/デストラクタ
SFXClip( Void )
SFXClip( SFXClipConstRef param )
SFXClip( SFXRectangleConstRef rectangle )
SFXClip( SFXCircleConstRef circle )
SFXClip( SFXEllipseConstRef ellipse )
SFXClip( SFXPieConstRef pie )
SFXClip( SFXTriangleConstRef triangle )
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 )
クリッピング領域の形状を未設定にします。
SFXClipRef Normalize( Void )
クリッピング領域を正規化します。
SFXClipRef Offset( SFXGridConstRef param )
Offset( SInt16 x , SInt16 y )
クリッピング領域の中心または頂点の座標を加算し、クリッピング領域を移動します。
SFXClipRef Set( SFXClipConstRef param )
Set( SFXPolygonConstRef polygon )
Set( SFXTriangleConstRef triangle )
Set( SFXPieConstRef pie )
Set( SFXEllipseConstRef ellipse )
Set( SFXCircleConstRef circle )
Set( SFXRectangleConstRef rectangle )
クリッピング領域を設定します。
SFXClipRef SetNone( Void )
クリッピング領域の形状を未定義にします。
SFXClipRef Unoffset( SFXGridConstRef param )
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   // 元になる多角形
);

参照

SFXRectangle | SFXCircle | SFXEllipse | SFXPie | SFXTriangle | SFXPolygon | SFXClip::operator=


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

参照

SFXClip::NoneInstance


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

戻り値

  • 等しいとき : true
  • 異なるとき : false

参照

operator== | operator!=


SFXClip::GetCircle
円を取得します。
[ public, const ]
SFXCircleConstRef GetCircle(Void);

解説

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

参照

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


SFXClip::GetEllipse
楕円を取得します。
[ public, const ]
SFXEllipseConstRef GetEllipse(Void);

解説

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

参照

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


SFXClip::GetPie
扇形を取得します。
[ public, const ]
SFXPieConstRef GetPie(Void);

解説

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

参照

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


SFXClip::GetPolygon
多角形を取得します。
[ public, const ]
SFXPolygonConstRef GetPolygon(Void);

解説

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

参照

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


SFXClip::GetRectangle
長方形を取得します。
[ public, const ]
SFXRectangleConstRef GetRectangle(Void);

解説

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

参照

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


SFXClip::GetTriangle
三角形を取得します。
[ public, const ]
SFXTriangleConstRef GetTriangle(Void);

解説

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

参照

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


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

戻り値

次の値を返します。

意味
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


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

戻り値

  • 円のとき : true
  • 円でないとき : false

参照

SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle


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

戻り値

  • 楕円のとき : true
  • 楕円でないとき : false

参照

SFXClip::IsCircle | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle


SFXClip::IsEmpty
クリッピング領域が有効な面積を持つか判定します。
[ public, const ]
Bool IsEmpty(Void);

戻り値

  • 有効な面積を持つとき : true
  • 有効な面積を持たないとき : false

解説

円・楕円・円弧・多角形・三角形・長方形のうち、いずれかが有効な面積を持つとき、true を返します。

参照

SFXRectangle::IsEmpty | SFXCircle::IsEmpty | SFXEllipse::IsEmpty | SFXPie::IsEmpty | SFXTriangle::IsEmpty | SFXPolygon::IsEmpty


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

戻り値

  • 形状が未設定のとき : true
  • 形状が設定されているとき : false

解説

タイプが CLIPPING_NONE のみ ture を返します。

参照

SFXClip::GetType


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

戻り値

  • 扇形のとき : true
  • 扇形でないとき : false

参照

SFXPie | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPolygon | SFXClip::IsRectangle | SFXClip::IsTriangle


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

戻り値

  • 多角形のとき : true
  • 多角形でないとき : false

参照

SFXPolygon | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsRectangle | SFXClip::IsTriangle


SFXClip::IsRectangle
クリッピング領域が長方形か判定します。
[ public, const ]
Bool IsRectangle(Void);

戻り値

  • 長方形のとき : true
  • 長方形でないとき : false

参照

SFXRectangle | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsTriangle


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

戻り値

  • 三角形のとき : true
  • 三角形でないとき : false

参照

SFXTriangle | SFXClip::IsCircle | SFXClip::IsEllipse | SFXClip::IsNone | SFXClip::IsPie | SFXClip::IsPolygon | SFXClip::IsRectangle


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

解説

形状が未定義の面積が 0 を表すインスタンスを取得します。

参照

SFXClip::EmptyInstance


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

解説

クリッピング領域が有効な面積を持つように、負の値の符号を反転します。

使用例

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

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

    clip.Normalize(); // clip を正規化

}

参照

SFXRectangle::Normalize | SFXCircle::Normalize | SFXEllipse::Normalize | SFXPie::Normalize | SFXTriangle::Normalize | SFXPolygon::Normalize


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

参照

SFXClip::Unoffset | operator- | operator+


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   // コピー元の多角形
);

参照

SFXRectangle | SFXCircle | SFXEllipse | SFXPie | SFXTriangle | SFXPolygon | SFXClip::operator=


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

参照

SFXClip::Set


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

参照

SFXClip::Offset | operator- | operator+


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

参照

SFXClip::AtomRec


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

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   // 中心または頂点の座標から減算する値
);

参照

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


operator-
クリッピング領域の中心または頂点の座標を減算し、クリッピング領域を移動します。
[ public, friend ]
SFXClip operator-(
    SFXClipConstRef left    // 移動対象のクリッピング領域
    SFXGridConstRef right   // 中心または頂点の座標から減算する値
);

参照

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   // 中心または頂点の座標に加算する値
);

参照

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


operator+
中心または頂点の座標を加算し、クリッピング領域を移動します。
[ public, friend ]
SFXClip operator+(
    SFXClipConstRef left    // 対象のクリッピング領域
    SFXGridConstRef right   // 中心または頂点の座標に加算する値
);

参照

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;
  };
};