FVCL::Data::CFvPolyline クラス

点列構造クラス [詳解]

詳解

点列構造クラス

namespace FVCL::Data

点列情報を保有するクラスです。

必要条件:

ヘッダー: FVCLbasic.h

解説:

点列の各点座標とオプション情報を保持します。 オプションが 0 以外の時は、点列の始点と終点が接続された多角形を意味します。

サブピクセル値を扱う場合は、座標の 0.0 を画素の中心とします。

FVCL::Data::CFvPolyline の継承関係図

公開型
enum	{ DataID = 17 }

公開メンバ関数
	CFvPolyline ()
	コンストラクタ [詳解]
	CFvPolyline (const CFvMultiData< CFvPoint > &points, INT opt=0)
	コンストラクタ [詳解]
	CFvPolyline (const CFvPolyline &src)
	コピーコンストラクタ [詳解]
virtual	~CFvPolyline ()
	デストラクタ [詳解]
virtual INT	GetDataID () const
	データIDの取得 [詳解]
virtual bool	GetPointer (INT id, void **val) const
	インスタンスのthisポインタの取得 [詳解]
bool	SetSize (UINT size)
	点列サイズ設定 [詳解]
UINT	GetSize () const
	点列の個数取得 [詳解]
bool	Add (const FVCL::Data::CFvPoint &point, UINT index)
	点の追加 [詳解]
bool	SetPoint (UINT index, const FVCL::Data::CFvPoint &point)
	点の設定 [詳解]
bool	GetPoint (UINT index, CFvPoint *point)
	データの取得 [詳解]
const FVCL::Data::CFvPoint &	GetPoint (UINT index) const
	データの取得 [詳解]
bool	SetPoints (const CFvMultiData< CFvPoint > &points)
	点列の設定 [詳解]
bool	GetPoints (CFvMultiData< CFvPoint > *points) const
	点列の取得 [詳解]
virtual CFvPoint &	operator[] (UINT index)
	配列要素への参照 [詳解]
virtual const FVCL::Data::CFvPoint &	operator[] (UINT index) const
	配列要素への参照 [詳解]
virtual CFvPolyline &	operator= (const CFvPolyline &src)
	代入オペレータ [詳解]
virtual bool	operator== (const CFvPolyline &src) const
	比較オペレータ(==) [詳解]
virtual bool	operator!= (const CFvPolyline &src) const
	比較オペレータ(!=) [詳解]
基底クラス FVCL::CFvDataObject に属する継承公開メンバ関数
	CFvDataObject ()
	標準のコンストラクタ [詳解]
virtual	~CFvDataObject ()
	デストラクタ [詳解]
virtual bool	Load (LPCTSTR szFileName)
	データファイルの読み込み [詳解]
virtual bool	Save (LPCTSTR szFileName)
	データファイル保存 [詳解]
基底クラス FVCL::CFvObject に属する継承公開メンバ関数
	CFvObject ()
	標準のコンストラクタ [詳解]
virtual	~CFvObject ()
	デストラクタ [詳解]
INT	SetErrorCode (INT err)
	エラーコードの設定 [詳解]
INT	SetErrorCode (INT err) const
	エラーコードの設定 [詳解]
INT	GetErrorCode () const
	エラーコードの取得 [詳解]
bool	SetAllocateOption (INT value)
	画像領域確保時のオプションの設定 [詳解]
INT	GetAllocateOption () const
	画像領域確保時のオプションの取得 [詳解]
void *	operator new (size_t uiSize)
	new オペレータ [詳解]
void *	operator new[] (size_t uiSize)
	new[] オペレータ [詳解]
void	operator delete (void *pvObject)
	delete オペレータ [詳解]
void	operator delete[] (void *pvObject)
	delete[] オペレータ [詳解]
void *	operator new (size_t uiSize, LPCSTR szFileName, INT iLine)
	new オペレータ [詳解]
void *	operator new[] (size_t uiSize, LPCSTR szFileName, INT iLine)
	new[] オペレータ [詳解]
void	operator delete (void *pvObject, LPCSTR szFileName, INT iLine)
	delete オペレータ [詳解]
void	operator delete[] (void *pvObject, LPCSTR szFileName, INT iLine)
	delete[] オペレータ [詳解]
virtual CFvObject &	operator= (const CFvObject &src)
	代入オペレータ [詳解]
virtual bool	operator== (const CFvObject &src) const
	比較オペレータ (==) [詳解]
virtual bool	operator!= (const CFvObject &src) const
	比較オペレータ (!=) [詳解]

公開変数類
INT	option
	オプション [詳解]

限定公開変数類
CFvArray< CFvPoint >	m_Points
	点列データ [詳解]
基底クラス FVCL::CFvObject に属する継承限定公開変数類
INT	m_ErrorCode
	エラーコード [詳解]
INT	m_AllocateOption
	画像領域確保時のオプション [詳解]

その他の継承メンバ
基底クラス FVCL::CFvObject に属する継承静的公開メンバ関数
static bool	SetDefaultAllocateOption (INT value)
	既定の画像領域確保時のオプションの設定 [詳解]
static INT	GetDefaultAllocateOption ()
	既定の画像領域確保時のオプションの取得 [詳解]
基底クラス FVCL::CFvObject に属する継承限定公開メンバ関数
INT	fnCPUCheck ()
	CPU情報の取得 [詳解]

列挙型メンバ詳解

anonymous enum

列挙値
DataID	点列構造クラスのデータID このクラスのデータIDです。

構築子と解体子

FVCL::Data::CFvPolyline::CFvPolyline

(

)

コンストラクタ

標準のコンストラクタです。 サイズ1の点列を生成し、0で初期化します。

例外

FVCL::CFveBadAllocException

メモリの確保に失敗しました。

FVCL::Data::CFvPolyline::CFvPolyline	(	const CFvMultiData< CFvPoint > &	points,
		INT	opt = 0
	)

コンストラクタ

初期値を指定してオブジェクトを構築します。

引数

[in]	points	点列
[in]	opt	オプション 0: 閉じる 1: 開く

例外

FVCL::CFveBadAllocException

メモリの確保に失敗しました。

FVCL::Data::CFvPolyline::CFvPolyline

(

const CFvPolyline &

src

)

コピーコンストラクタ

同一クラスのオブジェクトの内容を複製して、オブジェクトを構築します。

引数

[in]

src

コピー元

例外

FVCL::CFveBadAllocException

メモリの確保に失敗しました。

FVCL::Data::CFvPolyline::~CFvPolyline ( )

virtual

デストラクタ

このオブジェクトを破棄します。

関数詳解

FVCL::Data::CFvPolyline::GetDataID ( ) const

virtual

データIDの取得

データIDを取得します。

戻り値

データIDを返します。

参照

CFvPolyline::DataID

FVCL::CFvDataObjectを実装しています。

FVCL::Data::CFvPolyline::GetPointer ( INT  id, void **  val  ) const

virtual

インスタンスのthisポインタの取得

指定されたデータIDと自身のIDが一致する場合に thisポインタを返します。

引数

[in]	id	データID
[out]	val	thisポインタを格納する変数へのポインタ

戻り値

true	正常
false	異常

参照

CFvPolyline::DataID

FVCL::CFvDataObjectを実装しています。

FVCL::Data::CFvPolyline::SetSize

(

UINT

size

)

点列サイズ設定

点列のサイズを設定します。

引数

[in]

size

個数 (0~)

戻り値

true	正常
false	異常

解説:

現在の点列の個数を減少または増加する為に使用します。
増加した場合、増加分の各点は 0,0 に初期化されています。
メモリ確保に失敗した場合は、エラーを返します。

FVCL::Data::CFvPolyline::GetSize

(

)

const

点列の個数取得

点列の個数を取得します。

戻り値

点列の個数を返します。

FVCL::Data::CFvPolyline::Add	(	const FVCL::Data::CFvPoint &	point,
		UINT	index
	)

点の追加

点データを追加します。

引数

[in]	point	追加する点データ
[in]	index	追加位置

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
1	FVCL_ErrorCode::FAILED_TO_ALLOCATE	メモリの確保に失敗しました。

解説:

追加位置が点列よりも大きい値を示している場合、点列の終端に点を追加します。
追加位置が点列の中にあった場合、指定の位置に挿入します。

FVCL::Data::CFvPolyline::SetPoint	(	UINT	index,
		const FVCL::Data::CFvPoint &	point
	)

点の設定

指定の位置に点を設定します。

引数

[in]	index	設定位置 (0~(GetSize()-1))
[in]	point	点データ

戻り値

true	正常
false	異常

例外

FVCL::CFveBadAccessException

指定位置が間違っています。

解説:

指定位置のデータが存在しない場合、例外を発行します。

FVCL::Data::CFvPolyline::GetPoint	(	UINT	index,
		CFvPoint *	point
	)

データの取得

指定位置の点を取得します。

引数

[in]	index	取得位置 (0~(GetSize()-1))
[out]	point	点データ

戻り値

true	正常
false	異常

例外

FVCL::CFveBadAccessException

指定位置が間違っています。

解説:

指定位置のデータが存在しない場合、例外を発行します。
point に NULL が指定された場合は、エラーを返します。

FVCL::Data::CFvPolyline::GetPoint

(

UINT

index

)

const

データの取得

指定位置のデータを取得します。

引数

[in]

index

取得位置 (0~(GetSize()-1))

戻り値

点データ

例外

FVCL::CFveBadAccessException

指定位置が間違っています。

解説:

指定位置のデータが存在しない場合、例外を発行します。

FVCL::Data::CFvPolyline::SetPoints

(

const CFvMultiData< CFvPoint > &

points

)

点列の設定

点列を設定します。

引数

[in]

points

設定する点列

戻り値

true	正常
false	異常

解説:

現在の点列は、引数に指定された点列の個数でリサイズされ、データが上書きされます。 メモリ確保に失敗した場合は、エラーを返します。

FVCL::Data::CFvPolyline::GetPoints

(

CFvMultiData< CFvPoint > *

points

)

const

点列の取得

点列データを取得します。

引数

[out]

points

出力点列

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
1	FVCL_ErrorCode::FAILED_TO_ALLOCATE	メモリを確保できませんでした。
11	FVCL_ErrorCode::INVALID_PARAMETER	引数が無効です。

解説:

引数に指定された点列は、現在の点列の個数でリサイズされ、データが上書きされます。 メモリ確保に失敗した場合は、エラーを返します。

FVCL::Data::CFvPolyline::operator[] ( UINT  index )

virtual

配列要素への参照

メンバフィールドの m_Points 配列の要素への参照を取得します。

引数

[in]

index

配列指標 (0~)

戻り値

引数 index に指定された指標の要素への参照を返します。

例外

FVCL::CFveException

処理に失敗した場合は例外を発行します。 発行された例外インスタンスの GetErrorCode からエラーコードを取得できます。

エラーコード:

値	定数	内容
11	FVCL_ErrorCode::INVALID_PARAMETER	配列指標が無効です。

バージョン

FVCLbasic v2.0.0.0: 新規追加

参照

GetPoint
GetSize
m_Points

FVCL::Data::CFvPolyline::operator[] ( UINT  index ) const

virtual

配列要素への参照

メンバフィールドの m_Points 配列の要素への参照を取得します。

引数

[in]

index

配列指標 (0~)

戻り値

引数 index に指定された指標の要素への参照を返します。

例外

FVCL::CFveException

処理に失敗した場合は例外を発行します。 発行された例外インスタンスの GetErrorCode からエラーコードを取得できます。

エラーコード:

値	定数	内容
11	FVCL_ErrorCode::INVALID_PARAMETER	配列指標が無効です。

バージョン

FVCLbasic v2.0.0.0: 新規追加

参照

GetPoint
GetSize
m_Points

FVCL::Data::CFvPolyline::operator= ( const CFvPolyline &  src )

virtual

代入オペレータ

同一クラスのオブジェクトの内容を複製して、自身に代入します。

引数

[in]

src

複製元

戻り値

代入後の自身のオブジェクトへの参照を返します。

FVCL::Data::CFvPolyline::operator== ( const CFvPolyline &  src ) const

virtual

比較オペレータ(==)

同一クラスのオブジェクトの内容と比較します。

引数

[in]

src

チェック元

戻り値

true	一致
false	不一致

FVCL::Data::CFvPolyline::operator!= ( const CFvPolyline &  src ) const

virtual

比較オペレータ(!=)

同一クラスのオブジェクトの内容と比較します。

引数

[in]

src

チェック元

戻り値

true	不一致
false	一致

メンバ詳解

INT FVCL::Data::CFvPolyline::option

オプション

点列の始点と終点を閉じるか否かを指示するフラグです。
以下の値で指示します。

• 0: 終点を閉じません
• 1: 終点を閉じます

CFvArray< CFvPoint > FVCL::Data::CFvPolyline::m_Points

protected

点列データ