ReferencePlane クラス

ReferencePlane クラス
ここでは、 ReferencePlane クラスのコマンドを紹介します。
. [詳解]

ItemObjectを継承しています。

公開スロット
virtual void	AddPropertyByReference (const String &name, ReferenceObject *value)
	指定した変数に ReferenceObject オブジェクトを追加します。 [詳解]
double	GetAngle () const
	参照する面と軸からの、基準平面の角度を取得します。 [詳解]
double	GetDistance () const
	参照する面から基準平面までの距離を取得します。 [詳解]
ItemObject *	GetItem (const Variant &value) const
	アセンブリやパート、スケッチなどの［モデルマネージャ］ツリーに表示される各項目を取得します。 インデックスは、ツリーに表示される各項目に対して上から順番に番号が割り振られています。 [詳解]
String	GetName () const
	名称を取得します。 [詳解]
virtual Variant	GetProperty (const String &name) const
	指定した名前をもつプロパティの値を取得します。 [詳解]
bool	GetReverseForAngle () const
	面と軸からの角度を基に基準平面を作成する場合で、方向を反転しているときは　True　を取得します。 [詳解]
bool	GetReverseForDistance () const
	面からの距離を基に基準平面を作成する場合で、方向を反転しているときは　True　を取得します。 [詳解]
bool	GetReverseForPlane1 () const
	2平面から基準平面を作成する場合で、面1の方向を反転しているときは　True　を取得します。 [詳解]
bool	GetReverseForPlane2 () const
	2平面から基準平面を作成する場合で、面2の方向を反転しているときは　True　を取得します。 [詳解]
String	GetScriptTypeName () const
	オブジェクトのタイプ名の文字列を取得します。 [詳解]
int	GetType () const
	基準平面の指定方法を、番号で取得します。 [詳解]
String	GetTypeAsString () const
	基準平面の指定方法を、文字列で取得します。 [詳解]
virtual bool	IsValid () const
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	NumItems () const
	アイテムの個数を取得します。 [詳解]
void	SetAngle (double value)
	参照する面と軸からの、基準平面の角度を指定します。 [詳解]
void	SetDistance (double value)
	参照する面から基準平面までの距離を指定します。 [詳解]
void	SetName (const String &name)
	名称を設定します。 [詳解]
virtual void	SetProperty (const String &name, const Variant &value)
	プロパティの値を設定します。 [詳解]
virtual void	SetPropertyByReference (const String &name, ReferenceObject *value)
	プロパティの値を ReferenceObject オブジェクトで設定します。 [詳解]
void	SetReverseForAngle (bool value)
	面と軸からの角度を基に基準平面を作成する場合で、方向を反転するかどうかを指定します。 [詳解]
void	SetReverseForDistance (bool value)
	面からの距離を基に基準平面を作成する場合で、方向を反転するかどうかを指定します。 [詳解]
void	SetReverseForPlane1 (bool value)
	2面から基準平面を作成する場合で、面1の方向を反転するかどうかを指定します。 [詳解]
void	SetReverseForPlane2 (bool value)
	2面から基準平面を作成する場合で、面2の方向を反転するかどうかを指定します。 [詳解]
void	SetTargetFor2Planes (ReferenceObject *plane1, ReferenceObject *plane2)
	2平面から決定する面を基準平面とする場合に、参照される面と点を指定します。 [詳解]
void	SetTargetFor3Points (ReferenceObject *p1, ReferenceObject *p2, ReferenceObject *p3)
	3点から決定する面を基準平面とする場合に、参照される3点を指定します。 [詳解]
void	SetTargetForAngle (ReferenceObject *line, ReferenceObject *face)
	面と軸からの角度を基に基準平面を作成する場合に、参照される面と直線を指定します。 [詳解]
void	SetTargetForDistance (ReferenceObject *face)
	面からの距離を基に基準平面を作成する場合に、基準となる面と直線を指定します。 [詳解]
void	SetTargetForLineAndVertex (ReferenceObject *line, ReferenceObject *vertex)
	直線と1点から決定する面を基準平面とする場合に、参照される直線と点を指定します。 [詳解]
void	SetTargetForPlaneAndVertex (ReferenceObject *plane, ReferenceObject *vertex)
	平面と1点から決定する面を基準平面とする場合に、参照される面と点を指定します。 [詳解]
void	SetType (int t)
	基準平面の指定方法を、番号で指定します。 [詳解]
void	SetTypeByString (const String &t)
	基準平面の指定方法を、文字列で指定します。 [詳解]

詳解

ReferencePlane クラス
ここでは、 ReferencePlane クラスのコマンドを紹介します。
.

ReferencePlane クラスには次の操作に対応したコマンドが含まれます。

• 基準平面のパラメータ設定

このクラスで使用するプロパティについては、 こちら を参照してください。

関数詳解

void ItemObject::AddPropertyByReference ( const String &  name, ReferenceObject *  value  )

virtualslotinherited

指定した変数に ReferenceObject オブジェクトを追加します。

引数

name	プロパティ名
value	ReferenceObject オブジェクト（設定対象）

double ReferencePlane::GetAngle ( ) const

slot

参照する面と軸からの、基準平面の角度を取得します。

戻り値

角度

double ReferencePlane::GetDistance ( ) const

slot

参照する面から基準平面までの距離を取得します。

戻り値

距離

ItemObject * ItemObject::GetItem ( const Variant &  value ) const

slotinherited

アセンブリやパート、スケッチなどの［モデルマネージャ］ツリーに表示される各項目を取得します。 インデックスは、ツリーに表示される各項目に対して上から順番に番号が割り振られています。

引数

value

項目名またはインデックス

戻り値

ItemObject オブジェクト

String ItemObject::GetName ( ) const

slotinherited

名称を取得します。

戻り値

アイテム名

Variant ItemObject::GetProperty ( const String &  name ) const

virtualslotinherited

指定した名前をもつプロパティの値を取得します。

引数

name

プロパティ名

戻り値

各プロパティの型

bool ReferencePlane::GetReverseForAngle ( ) const

slot

面と軸からの角度を基に基準平面を作成する場合で、方向を反転しているときは　True　を取得します。

戻り値

方向を反転しているか否か

bool ReferencePlane::GetReverseForDistance ( ) const

slot

面からの距離を基に基準平面を作成する場合で、方向を反転しているときは　True　を取得します。

戻り値

方向を反転しているか否か

bool ReferencePlane::GetReverseForPlane1 ( ) const

slot

2平面から基準平面を作成する場合で、面1の方向を反転しているときは　True　を取得します。

戻り値

方向を反転しているか否か

bool ReferencePlane::GetReverseForPlane2 ( ) const

slot

2平面から基準平面を作成する場合で、面2の方向を反転しているときは　True　を取得します。

戻り値

方向を反転しているか否か

String ItemObject::GetScriptTypeName ( ) const

slotinherited

オブジェクトのタイプ名の文字列を取得します。

戻り値

オブジェクトのタイプ名

int ReferencePlane::GetType ( ) const

slot

基準平面の指定方法を、番号で取得します。

戻り値

0 : 直線と点からの指定
1 : 3点指定
2 : 2面からの距離の指定
3 : 面と軸からの角度指定
4 : 平面と点からの指定
5 : 2平面指定

String ReferencePlane::GetTypeAsString ( ) const

slot

基準平面の指定方法を、文字列で取得します。

戻り値

LineVertex : 直線と点からの指定
3Vertex : 3点指定
Distance : 2面からの距離の指定
Angle : 面と軸からの角度指定
PlaneVertex : 平面と点からの指定
2Plane : 2平面指定

bool ItemObject::IsValid ( ) const

virtualslotinherited

オブジェクトが有効であるとき、戻り値として True を取得します。

戻り値

オブジェクトの有効・無効

int ItemObject::NumItems ( ) const

slotinherited

アイテムの個数を取得します。

戻り値

アイテム数

void ReferencePlane::SetAngle ( double  value )

slot

参照する面と軸からの、基準平面の角度を指定します。

引数

value

角度

void ReferencePlane::SetDistance ( double  value )

slot

参照する面から基準平面までの距離を指定します。

引数

value

距離

void ItemObject::SetName ( const String &  name )

slotinherited

名称を設定します。

引数

name

アイテム名

void ItemObject::SetProperty ( const String &  name, const Variant &  value  )

virtualslotinherited

プロパティの値を設定します。

引数

name	プロパティ名
value	プロパティの値

void ItemObject::SetPropertyByReference ( const String &  name, ReferenceObject *  value  )

virtualslotinherited

プロパティの値を ReferenceObject オブジェクトで設定します。

引数

name	プロパティ名
value	ReferenceObject オブジェクト（設定対象）

void ReferencePlane::SetReverseForAngle ( bool  value )

slot

面と軸からの角度を基に基準平面を作成する場合で、方向を反転するかどうかを指定します。

引数

value

True=on : 反転する False=off : 反転しない

void ReferencePlane::SetReverseForDistance ( bool  value )

slot

面からの距離を基に基準平面を作成する場合で、方向を反転するかどうかを指定します。

引数

value

True=on : 反転する False=off : 反転しない

void ReferencePlane::SetReverseForPlane1 ( bool  value )

slot

2面から基準平面を作成する場合で、面1の方向を反転するかどうかを指定します。

引数

value

True=on : 反転する False=off : 反転しない

void ReferencePlane::SetReverseForPlane2 ( bool  value )

slot

2面から基準平面を作成する場合で、面2の方向を反転するかどうかを指定します。

引数

value

True=on : 反転する False=off : 反転しない

void ReferencePlane::SetTargetFor2Planes ( ReferenceObject *  plane1, ReferenceObject *  plane2  )

slot

2平面から決定する面を基準平面とする場合に、参照される面と点を指定します。

引数

face1	ReferenceObject オブジェクト（面のオブジェクト）
face2	ReferenceObject オブジェクト（面のオブジェクト）

void ReferencePlane::SetTargetFor3Points ( ReferenceObject *  p1, ReferenceObject *  p2, ReferenceObject *  p3  )

slot

3点から決定する面を基準平面とする場合に、参照される3点を指定します。

引数

p1	ReferenceObject オブジェクト（点のオブジェクト）
p2	ReferenceObject オブジェクト（点のオブジェクト）
p3	ReferenceObject オブジェクト（点のオブジェクト）

void ReferencePlane::SetTargetForAngle ( ReferenceObject *  line, ReferenceObject *  face  )

slot

面と軸からの角度を基に基準平面を作成する場合に、参照される面と直線を指定します。

引数

line	ReferenceObject オブジェクト（直線のオブジェクト）
face	ReferenceObject オブジェクト（面のオブジェクト）

void ReferencePlane::SetTargetForDistance ( ReferenceObject *  face )

slot

面からの距離を基に基準平面を作成する場合に、基準となる面と直線を指定します。

引数

face	ReferenceObject オブジェクト（面のオブジェクト）

void ReferencePlane::SetTargetForLineAndVertex ( ReferenceObject *  line, ReferenceObject *  vertex  )

slot

直線と1点から決定する面を基準平面とする場合に、参照される直線と点を指定します。

引数

line	ReferenceObject オブジェクト（直線のオブジェクト）
vertex	ReferenceObject オブジェクト（点のオブジェクト）

void ReferencePlane::SetTargetForPlaneAndVertex ( ReferenceObject *  plane, ReferenceObject *  vertex  )

slot

平面と1点から決定する面を基準平面とする場合に、参照される面と点を指定します。

引数

face	ReferenceObject オブジェクト（面のオブジェクト）
vertex	ReferenceObject オブジェクト（点のオブジェクト）

void ReferencePlane::SetType ( int  t )

slot

基準平面の指定方法を、番号で指定します。

引数

t	0 : 直線と点からの指定 1 : 3点指定 2 : 2面からの距離の指定 3 : 面と軸からの角度指定 4 : 平面と点からの指定 5 : 2平面指定

void ReferencePlane::SetTypeByString ( const String &  t )

slot

基準平面の指定方法を、文字列で指定します。

引数

t	LineVertex : 直線と点からの指定 3Vertex : 3点指定 Distance : 2面からの距離の指定 Angle : 面と軸からの角度指定 PlaneVertex : 平面と点からの指定 2Plane : 2平面指定