SFUPolyline

多角線を表すクラスです。

#include <SFUPolyline.hpp>

class SFUPolyline : public AEEPolyline;

typedef SFUPolyline&          SFUPolylineRef;
typedef SFUPolyline*          SFUPolylinePtr;
typedef SFUPolyline**         SFUPolylineHandle;
typedef const SFUPolyline     ConstSFUPolyline;
typedef const SFUPolyline&    ConstSFUPolylineRef;
typedef const SFUPolyline*    ConstSFUPolylinePtr;
typedef const SFUPolyline**   ConstSFUPolylineHandle;

解説

SFUPolyline は多角線を表すクラスです。多角線は内部的には点配列です。

参照

SFUPolyline::Set

メンバ

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

パブリック変数
public	len	多角線の点の数です。
public	points	多角線の点配列へのポインタです。

パブリック関数
public	Append	点配列に点を追加します。
public	Clear	多角線をクリアします。
public	Equal	2 つの多角線が等しいか判定します。
public	Get	多角線の点配列内の点を取得します。
public	Insert	多角線の点配列に点を挿入します。
public	Length	多角線の点の数を返します。
public	Offset	多角線を移動します。
public	Points	多角線の点配列のポインタを返します。
public	Remove	多角線の点配列から点を削除します。
public	Set	点配列をコピーします。
public	operator+	多角線を移動します。
public	operator-	多角線を逆移動します。
public	operator==	2 つの多角線を比較します。

SFUPolyline::SFUPolyline

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

[ public ]
SFUPolyline(Void);

[ public ]
SFUPolyline(
    ConstAEEPolylineRef polyline   // コピー元の多角線
);

[ public ]
SFUPolyline(
    SInt16 size               // points 配列内の点の数
    ConstSFUPointPtr points   // 点配列へのポインタ
);

参照

SFUPolyline::Set

SFUPolyline::~SFUPolyline

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

[ public ]
~SFUPolyline(Void);

SFUPolyline::Append

点配列に点を追加します。

[ public ]
Bool Append(
    ConstSFUPointRef point   // 追加する点
);

参照

SFUPolyline::Insert

SFUPolyline::Clear

多角線をクリアします。

[ public ]
Void Clear(Void);

解説

多角形をクリアすると、 Length() で返される点の数は 0 になり、 Points() で返される点配列ポインタは NULL になります。

参照

SFUPolyline::Remove

SFUPolyline::Equal

2 つの多角線が等しいか判定します。

[ public, const ]
Bool Equal(
    ConstSFUPolylineRef polyline   // 比較対象の多角線
);

参照

SFUPolygon::operator==

SFUPolyline::Get

多角線の点配列内の点を取得します。

[ public ]
SFUPoint Get(
    SIntN index   // 点のインデックス
);

参照

SFUPolygon::Points

SFUPolyline::Insert

多角線の点配列に点を挿入します。

[ public ]
Bool Insert(
    SIntN index              // 挿入位置のインデックス
    ConstSFUPointRef point   // 挿入する点
);

戻り値

挿入に成功すると TRUE を返します。失敗すると FALSE を返します。

参照

SFUPolyline::Append

SFUPolyline::Length

多角線の点の数を返します。

[ public ]
SIntN Length(Void);

参照

SFUPolyline::Points

SFUPolyline::Offset

多角線を移動します。

[ public ]
ConstSFUPolylineRef Offset(
    SInt16 dx   // X 方向の移動量
    SInt16 dy   // Y 方向の移動量
);

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

参照

SFUPolyline::operator+ | SFUPolyline::operator-

SFUPolyline::Points

多角線の点配列のポインタを返します。

[ public ]
SFUPointPtr Points(Void);

解説

返される配列ポインタは、多角形に点を追加したり削除したりすると、無効なポインタになる可能性があります。そのため、ポインタを記録して使いまわすことはしないでください。

参照

SFUPolyline::Get

SFUPolyline::Remove

多角線の点配列から点を削除します。

[ public ]
Void Remove(
    SIntN index   // 削除する点のインデックス
);

参照

SFUPolyline::Clear

SFUPolyline::Set

点配列をコピーします。

[ public ]
ConstSFUPolylineRef Set(
    ConstAEEPolylineRef polyline   // コピーする AEEPolyline 構造体 
);

[ public ]
ConstSFUPolylineRef Set(
    SInt16 size               // 点の数
    ConstSFUPointPtr points   // 点配列へのポインタ
);

戻り値

自分自身を返します。

SFUPolyline::operator==

2 つの多角線を比較します。

[ public, friend ]
Bool operator==(
    ConstSFUPolylineRef polyline1   
    ConstSFUPolylineRef polyline2   
);

[ public, friend ]
Bool operator!=(
    ConstSFUPolylineRef polyline1   
    ConstSFUPolylineRef polyline2   
);

戻り値

2 つの多角線の点配列に格納された点の座標が、すべて一致すれば TRUE を返します。そうでなければ FALSE を返します。この比較においては、点配列に格納される点の順序が意味をもちます。点配列の同じインデックスに格納された点が比較されます。

参照

SFUPolyline::Equal

SFUPolyline::operator-

多角線を逆移動します。

[ public, friend ]
SFUPolyline operator-(
    ConstSFUPolylineRef polyline   // 逆移動する多角線
    ConstSFUPointRef vector        // 逆移動する方向
);

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

参照

SFUPolygon::Offset | SFUPolygon::operator+

SFUPolyline::operator+

多角線を移動します。

[ public, friend ]
SFUPolyline operator+(
    ConstSFUPolylineRef polyline   // 移動する多角線
    ConstSFUPointRef vector        // 移動する方向
);

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

参照

SFUPolygon::Offset | SFUPolygon::operator-

SFUPolyline::len

多角線の点の数です。

[ public ]
SInt16 len;

SFUPolyline::points

多角線の点配列へのポインタです。

[ public ]
AEEPoint* points;