VectorDefinition クラスはベクトルプロットの設定に使用します。
このクラスは Study クラスから呼び出すことができます。
. [詳解]

ResultDefinitionを継承しています。

公開メンバ関数
void	AddCutPlane (Variant &index)
	設定するカット面を追加します。 [詳解]

void	AddPart (int partId)
	ベクトルの描画対象とする部品のリストに、新たな部品を追加します。 [詳解]

void	ClearCutPlanes ()
	カット面設定をクリアします。

String	DigitsNotationTypeName ()
	スケールバーの目盛の数値表記タイプを取得します。 [詳解]

String	GetArrowCoordinateName ()
	グリッド表示に適用されている座標系の名称を取得します。 [詳解]

bool	GetAutoScale ()
	自動スケールに設定されている場合、戻り値として True を取得します。 [詳解]

StringList	GetCutPlaneList ()
	カット面設定のインデックスリストを取得します。 [詳解]

bool	GetDisplayAllParts ()
	全ての部品を描画対象とするか否かを取得します。 [詳解]

bool	GetDisplayScaleBar ()
	スケールバーを表示する時に True を取得します。 [詳解]

bool	GetDisplayShellBeam ()
	シェル・ビームの表示・非表示を取得します。 [詳解]

int	GetDisplayType ()
	表示タイプを取得します。 [詳解]

bool	GetDynamicZoom ()
	ダイナミックズームのオン・オフを取得します。 [詳解]

String	GetGradientName ()
	グラデーションのタイプ名を、文字列で取得します。 [詳解]

Variant	GetGradientNames ()
	グラデーションのタイプの名称リストを取得します。 [詳解]

double	GetGridSize ()
	グリッドサイズまたは最小距離を取得します。 [詳解]

int	GetLeftPosition ()
	ユーザが指定したLeft位置の値を取得します。 [詳解]

int	GetLevels ()
	色のレベル数を、整数で取得します。 [詳解]

bool	GetLogScale ()
	スケーリングの種類を取得します。スケーリングが対数目盛の場合、True が取得されます。 [詳解]

double	GetMax ()
	最大値を実数で取得します。 [詳解]

double	GetMin ()
	最小値を実数で取得します。 [詳解]

bool	GetModelCopy ()
	モデルコピー表示設定を取得します。設定されている場合 True が取得されます。 [詳解]

String	GetName ()
	プロットの名称を文字列で取得します。 [詳解]

int	GetNumLabels ()
	スケールバーのラベル数を取得します。 [詳解]

int	GetNumSkips ()
	スキップ数を取得します。 [詳解]

int	GetNumVectors ()
	総ベクトル数を取得します。 [詳解]

String	GetPlace ()
	矢印の位置を、文字列で取得します。 [詳解]

Variant	GetPlaceNames ()
	矢印の位置の名称リストを取得します。 [詳解]

String	GetResultCoordinateName ()
	コンター表示に適用されている座標系の名称を取得します。 [詳解]

String	GetResultCoordinateNameList ()
	コンターに適用可能な座標系の一覧を取得します。 [詳解]

virtual String	GetResultType ()
	結果のタイプの名称を、文字列で取得します。 [詳解]

Variant	GetResultTypeNames ()
	結果のタイプの名称リストを取得します。 [詳解]

bool	GetScaleByParts ()
	スケーリングを表示モデルの最大/最小値から決めるかどうかのフラグを取得します。 [詳解]

bool	GetScaled ()
	矢印の長さが自動に設定されている場合、戻り値として True を取得します。 [詳解]

Condition *	GetScalingFactor ()
	設定されているスケーリングを取得します。 [詳解]

double	GetSize ()
	矢印のサイズを、実数で取得します。 [詳解]

bool	GetSmooth ()
	スムースに設定されている場合、戻り値として True を取得します。 [詳解]

String	GetStyle ()
	矢印のタイプを、文字列で取得します。 [詳解]

Variant	GetStyleNames ()
	矢印のタイプの名称リストを取得します。 [詳解]

int	GetTopPosition ()
	ユーザが指定したTop位置の値を取得します。 [詳解]

bool	GetTransparencyNonTarget ()
	対象部品以外に透明度の設定を取得します。設定されている場合 True が取得されます。 [詳解]

int	GetTransparencyValueNonTarget ()
	対象部品以外の透明度を取得します。 [詳解]

bool	GetUseSpecifiedPosition ()
	ユーザが指定した位置にスケールバーを表示したい時に True を取得します。 [詳解]

int	GetVectorType ()
	ベクトルタイプを取得します。 [詳解]

int	GetViewIndex ()
	設定されている視点のインデックスを取得します。 [詳解]

bool	GetViewOriginalModel ()
	原型図表示設定を取得します。設定されている場合 True が取得されます。 [詳解]

bool	GetViewPoint ()
	視点設定を取得します。設定されている場合Trueが取得されます。 [詳解]

bool	GetViewScale ()
	スケール表示設定を取得します。設定されている場合Trueが取得されます。 [詳解]

bool	IsEditMode ()
	編集モードかどうかを取得します [詳解]

bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]

int	Precision ()
	スケールバーの目盛の小数点以下の表示桁数を取得します。 [詳解]

void	RemoveAllParts ()
	ベクトルの描画対象とする部品のリストから、全ての部品を削除します。

void	SetArrow (String &style, String &place, bool scale, Variant &length)
	矢印の引数を設定します。 [詳解]

void	SetArrowCoordinate (Variant &name)
	名称を指定して、グリッド表示に座標系を適用します。 [詳解]

void	SetAutoScale (bool scale)
	自動スケールのフラグを設定します。 [詳解]

void	SetDigitsNotationType (Variant &type)
	スケールバーの目盛の数値表記タイプを設定します。 [詳解]

void	SetDisplayAllParts (bool use)
	全ての部品を描画の対象とするか否かを指定します。 [詳解]

void	SetDisplayScaleBar (bool displayScaleBar)
	スケールバー表示を設定します。 [詳解]

void	SetDisplayShellBeam (bool isChecked)
	シェル・ビームの表示・非表示を設定します。 [詳解]

void	SetDisplayType (int type)
	表示タイプを指定します。 [詳解]

void	SetDynamicZoom (bool zoom)
	ダイナミックズームのオン・オフを指定します。 [詳解]

void	SetEditMode ()
	一括で設定を行う場合の編集モードを設定します。 SetEditMode関数をコール後はUpdate関数をコールするまで結果項目の更新を行いません。

void	SetGradient (String &name, Variant &levels, bool smooth)
	色のグラデーションを設定するための引数を設定します。 [詳解]

void	SetGridSize (Variant &size)
	グリッドサイズまたは最小距離を指定します。 [詳解]

void	SetLogScale (bool logscale)
	スケーリングの種類を指定します。値を True に設定すると、スケーリングが対数目盛になります。 [詳解]

void	SetModelCopy (bool on)
	モデルコピー表示を設定します。 [詳解]

void	SetName (String &name)
	プロットの名称を設定します。 [詳解]

void	SetNumLabels (Variant &labels)
	スケールバーのラベル数を設定します。 [詳解]

void	SetNumSkips (Variant &skip)
	スキップ数を指定します。 [詳解]

void	SetNumVectors (Variant &vectors)
	総ベクトル数を指定します。 [詳解]

void	SetPlace (String &place)
	矢印の位置を設定します。 [詳解]

void	SetPrecision (Variant &precision)
	スケールバーの目盛の小数点以下の表示桁数を設定します。 [詳解]

void	SetRange (Variant &min, Variant &max)
	最小値と最大値の間で、レンジを設定します。 [詳解]

void	SetResultCoordinate (Variant &name)
	コンター表示に適用されている座標系の名称を取得します。 [詳解]

virtual void	SetResultType (String &typeName, String &sourceTitle=String())
	結果のタイプを設定します。 [詳解]

void	SetScaleBarPosition (Variant &leftPos, Variant &topPos)
	スケールバーの位置を設定します。 [詳解]

void	SetScaleByParts (bool scaleByParts)
	スケーリングを表示モデルの最大/最小値から決めるかどうかを設定します。 [詳解]

void	SetScaled (bool scaled)
	矢印の長さを設定します。 [詳解]

void	SetScalingFactor (Condition *cond)
	Condition オブジェクトを指定してスケーリングを設定します。 [詳解]

void	SetSize (Variant &size)
	矢印のサイズを設定します。 [詳解]

void	SetStyle (String &style)
	矢印のタイプを設定します。 [詳解]

void	SetTransparencyNonTarget (bool on)
	対象部品以外に透明度を設定します。 [詳解]

void	SetTransparencyValueNonTarget (Variant &value)
	対象部品以外の透明度を設定します。 [詳解]

void	SetUseSpecifiedPosition (bool useSpecifiedPosition)
	スケールバーの指定した位置を使用するかどうかを設定します。 [詳解]

void	SetVectorType (int type)
	ベクトルタイプを指定します。 [詳解]

void	SetViewIndex (Variant &index)
	視点のインデックスを指定し、視点を設定します。 [詳解]

void	SetViewName (Variant &name)
	視点の名前を指定し、視点を設定します。 [詳解]

void	SetViewOriginalModel (bool on)
	原型図表示を設定します。 [詳解]

void	SetViewPoint (bool on)
	視点を設定します。 [詳解]

void	SetViewScale (bool on)
	スケール表示を設定します。 [詳解]

void	Update ()
	編集モードを解除して更新処理を行います。編集モード以外にコールするとスクリプトエラー

詳解

VectorDefinition クラスはベクトルプロットの設定に使用します。
このクラスは Study クラスから呼び出すことができます。
.

このクラスのオブジェクトを取得する例:

app.GetModel(0).GetStudy(0).GetVector(0)

関数詳解

void ResultDefinition::AddCutPlane ( Variant & index )

inherited

設定するカット面を追加します。

引数

index カット面のインデックスまたは名前

void VectorDefinition::AddPart ( int partId )

ベクトルの描画対象とする部品のリストに、新たな部品を追加します。

引数

partId 部品のID

String ResultDefinition::DigitsNotationTypeName ( )

inherited

スケールバーの目盛の数値表記タイプを取得します。

戻り値: 数値表記タイプ

automatic ：自動

sientific ：指数表示

decimal ：小数点表示

String VectorDefinition::GetArrowCoordinateName ( )

グリッド表示に適用されている座標系の名称を取得します。

戻り値: 座標系の名称

bool ResultDefinition::GetAutoScale ( )

inherited

自動スケールに設定されている場合、戻り値として True を取得します。

戻り値: 自動スケールのオン/オフ

StringList ResultDefinition::GetCutPlaneList ( )

inherited

カット面設定のインデックスリストを取得します。

戻り値: インデックスリスト

bool VectorDefinition::GetDisplayAllParts ( )

全ての部品を描画対象とするか否かを取得します。

戻り値: 全ての部品を描画対象とするか否か

bool ResultDefinition::GetDisplayScaleBar ( )

inherited

スケールバーを表示する時に True を取得します。

戻り値: スケールバーを表示するかどうか

bool VectorDefinition::GetDisplayShellBeam ( )

シェル・ビームの表示・非表示を取得します。

戻り値: シェル・ビームの表示・非表示

int VectorDefinition::GetDisplayType ( )

表示タイプを取得します。

戻り値: 表示タイプ
0 : シェーディング

1 : 隠線なし

2 : ワイヤフレーム

bool VectorDefinition::GetDynamicZoom ( )

ダイナミックズームのオン・オフを取得します。

戻り値: ダイナミックズームのオン・オフ

String ResultDefinition::GetGradientName ( )

inherited

グラデーションのタイプ名を、文字列で取得します。

戻り値: グラデーションのタイプ名

Variant ResultDefinition::GetGradientNames ( )

inherited

グラデーションのタイプの名称リストを取得します。

戻り値: グラデーションのタイプ名リスト

double VectorDefinition::GetGridSize ( )

グリッドサイズまたは最小距離を取得します。

戻り値: グリッドサイズまたは最小距離

int ResultDefinition::GetLeftPosition ( )

inherited

ユーザが指定したLeft位置の値を取得します。

戻り値: Left位置の値

int ResultDefinition::GetLevels ( )

inherited

色のレベル数を、整数で取得します。

戻り値: 色のレベル数

bool ResultDefinition::GetLogScale ( )

inherited

スケーリングの種類を取得します。スケーリングが対数目盛の場合、True が取得されます。

戻り値: 対数目盛のオン/オフ

double ResultDefinition::GetMax ( )

inherited

最大値を実数で取得します。

戻り値: 最大値

double ResultDefinition::GetMin ( )

inherited

最小値を実数で取得します。

戻り値: 最小値

bool ResultDefinition::GetModelCopy ( )

inherited

モデルコピー表示設定を取得します。設定されている場合 True が取得されます。

戻り値: モデルコピー表示のオン/オフ

String ResultDefinition::GetName ( )

inherited

プロットの名称を文字列で取得します。

戻り値: プロットの名称

int ResultDefinition::GetNumLabels ( )

inherited

スケールバーのラベル数を取得します。

戻り値: スケールバーのラベル数

int VectorDefinition::GetNumSkips ( )

スキップ数を取得します。

戻り値: スキップ数

int VectorDefinition::GetNumVectors ( )

総ベクトル数を取得します。

戻り値: 総ベクトル数

String VectorDefinition::GetPlace ( )

矢印の位置を、文字列で取得します。

戻り値: 矢印の位置

Variant VectorDefinition::GetPlaceNames ( )

矢印の位置の名称リストを取得します。

戻り値: 矢印の位置の名称リスト

String ResultDefinition::GetResultCoordinateName ( )

inherited

コンター表示に適用されている座標系の名称を取得します。

戻り値: 座標系の名称

String ResultDefinition::GetResultCoordinateNameList ( )

inherited

コンターに適用可能な座標系の一覧を取得します。

戻り値: 座標系の名称一覧

String ResultDefinition::GetResultType ( )

virtualinherited

結果のタイプの名称を、文字列で取得します。

戻り値: 結果のタイプの名称

FluxLineDefinitionで再実装されています。

Variant ResultDefinition::GetResultTypeNames ( )

inherited

結果のタイプの名称リストを取得します。

戻り値: 結果のタイプの名称リスト

bool VectorDefinition::GetScaleByParts ( )

スケーリングを表示モデルの最大/最小値から決めるかどうかのフラグを取得します。

戻り値: 表示モデルから最大/最小値を決定のオン/オフ

bool VectorDefinition::GetScaled ( )

矢印の長さが自動に設定されている場合、戻り値として True を取得します。

戻り値: 矢印の長さが自動か否か

Condition * ResultDefinition::GetScalingFactor ( )

inherited

設定されているスケーリングを取得します。

戻り値: Condition オブジェクト

double VectorDefinition::GetSize ( )

矢印のサイズを、実数で取得します。

戻り値: 矢印のサイズ（1-100）

bool ResultDefinition::GetSmooth ( )

inherited

スムースに設定されている場合、戻り値として True を取得します。

戻り値: スムースのオン/オフ

String VectorDefinition::GetStyle ( )

矢印のタイプを、文字列で取得します。

戻り値: 矢印のタイプ

SimpleCone

Cone

Pyramid

Wire

Line

Variant VectorDefinition::GetStyleNames ( )

矢印のタイプの名称リストを取得します。

戻り値: 矢印のタイプ名リスト

int ResultDefinition::GetTopPosition ( )

inherited

ユーザが指定したTop位置の値を取得します。

戻り値: Top位置の値

bool ResultDefinition::GetTransparencyNonTarget ( )

inherited

対象部品以外に透明度の設定を取得します。設定されている場合 True が取得されます。

戻り値: 透明度のオン/オフ

int ResultDefinition::GetTransparencyValueNonTarget ( )

inherited

対象部品以外の透明度を取得します。

戻り値: 透明度(0~100)

bool ResultDefinition::GetUseSpecifiedPosition ( )

inherited

ユーザが指定した位置にスケールバーを表示したい時に True を取得します。

戻り値: ユーザが指定した位置にスケールバーを表示するかどうか

int VectorDefinition::GetVectorType ( )

ベクトルタイプを取得します。

戻り値: ベクトルタイプ

0=総ベクトル数指定またはスキップ数指定

1=グリッドサイズまたは最小距離指定

int ResultDefinition::GetViewIndex ( )

inherited

設定されている視点のインデックスを取得します。

戻り値: 視点のインデックス

bool ResultDefinition::GetViewOriginalModel ( )

inherited

原型図表示設定を取得します。設定されている場合 True が取得されます。

戻り値: 原型図表示のオン/オフ

bool ResultDefinition::GetViewPoint ( )

inherited

視点設定を取得します。設定されている場合Trueが取得されます。

戻り値: 視点設定のオン/オフ

bool ResultDefinition::GetViewScale ( )

inherited

スケール表示設定を取得します。設定されている場合Trueが取得されます。

戻り値: スケール表示のオン/オフ

bool ResultDefinition::IsEditMode ( )

inherited

編集モードかどうかを取得します

戻り値: 編集モードかどうか

bool ResultDefinition::IsValid ( )

inherited

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

戻り値: ResultDefinition オブジェクトの有効/無効

int ResultDefinition::Precision ( )

inherited

スケールバーの目盛の小数点以下の表示桁数を取得します。

戻り値: 小数点以下の表示桁数

void VectorDefinition::SetArrow	(	String &	style,
		String &	place,
		bool	scale,
		Variant &	length
	)

矢印の引数を設定します。

引数

style	タイプ
place	位置
scale	長さ
length	サイズ

void VectorDefinition::SetArrowCoordinate ( Variant & name )

名称を指定して、グリッド表示に座標系を適用します。

引数

name	座標系の名称またはインデックス

void ResultDefinition::SetAutoScale ( bool scale )

inherited

自動スケールのフラグを設定します。

引数

scale オン/オフ

void ResultDefinition::SetDigitsNotationType ( Variant & type )

inherited

スケールバーの目盛の数値表記タイプを設定します。

引数

type	数値表記タイプ automatic ：自動 sientific ：指数表示 decimal ：小数点表示

void VectorDefinition::SetDisplayAllParts ( bool use )

全ての部品を描画の対象とするか否かを指定します。

引数

use	True=1 : ［全ての部品を対象とする］を有効にする False=0 : ［全ての部品を対象とする］を無効にする

void ResultDefinition::SetDisplayScaleBar ( bool displayScaleBar )

inherited

スケールバー表示を設定します。

引数

displayScaleBar スケールバーを表示のオン/オフ

void VectorDefinition::SetDisplayShellBeam ( bool isChecked )

シェル・ビームの表示・非表示を設定します。

引数

isChecked

True=1 : ［シェル・ビームを自動表示する］を有効にする

False=0 : ［シェル・ビームを自動表示する］を無効にする

void VectorDefinition::SetDisplayType ( int type )

表示タイプを指定します。

引数

type	0 : シェーディング 1 : 隠線なし 2 : ワイヤフレーム

void VectorDefinition::SetDynamicZoom ( bool zoom )

ダイナミックズームのオン・オフを指定します。

引数

zoom	True=1 : ダイナミックズームをオン False=0 : ダイナミックズームをオフ

void ResultDefinition::SetGradient	(	String &	name,
		Variant &	levels,
		bool	smooth
	)

inherited

色のグラデーションを設定するための引数を設定します。

引数

name	グラデーション PurpleRed：紫-赤 BlueRed：青-赤 GrayScale：グレー CMR：CMR
levels	レベル数
smooth	スムースカラーバンド

void VectorDefinition::SetGridSize ( Variant & size )

グリッドサイズまたは最小距離を指定します。

引数

size	グリッドサイズまたは最小距離

void ResultDefinition::SetLogScale ( bool logscale )

inherited

スケーリングの種類を指定します。値を True に設定すると、スケーリングが対数目盛になります。

引数

logscale

True=1 : 対数目盛

False=0 : 線形目盛

void ResultDefinition::SetModelCopy ( bool on )

inherited

モデルコピー表示を設定します。

引数

on	モデルコピー表示のオン/オフ

void ResultDefinition::SetName ( String & name )

inherited

プロットの名称を設定します。

引数

name プロットの名称

void ResultDefinition::SetNumLabels ( Variant & labels )

inherited

スケールバーのラベル数を設定します。

引数

labels ラベル数

void VectorDefinition::SetNumSkips ( Variant & skip )

スキップ数を指定します。

引数

skip スキップ数

void VectorDefinition::SetNumVectors ( Variant & vectors )

総ベクトル数を指定します。

引数

vectors ベクトル数

void VectorDefinition::SetPlace ( String & place )

矢印の位置を設定します。

引数

place 矢印の位置

void ResultDefinition::SetPrecision ( Variant & precision )

inherited

スケールバーの目盛の小数点以下の表示桁数を設定します。

引数

precision 小数点以下の表示桁数

void ResultDefinition::SetRange	(	Variant &	min,
		Variant &	max
	)

inherited

最小値と最大値の間で、レンジを設定します。

引数

min	最小値
max	最大値

void ResultDefinition::SetResultCoordinate ( Variant & name )

inherited

コンター表示に適用されている座標系の名称を取得します。

引数

name	座標系の名称またはインデックス

void VectorDefinition::SetResultType	(	String &	typeName,
		String &	sourceTitle = `String()`
	)

virtual

結果のタイプを設定します。

引数

typeName	結果タイプ名
sourceTitle	計算ツールを参照する場合は、結果の計算処理（フーリエ変換など）のタイトル

引数 "sourceTitle" は省略できます。
引数 "typeName" として指定可能な条件タイプ名については、物理量の表示状態を変更するものを参照してください。

ResultDefinitionを再実装しています。

void ResultDefinition::SetScaleBarPosition	(	Variant &	leftPos,
		Variant &	topPos
	)

inherited

スケールバーの位置を設定します。

引数

leftPos	左からの位置
topPos	下からの位置

void VectorDefinition::SetScaleByParts ( bool scaleByParts )

スケーリングを表示モデルの最大/最小値から決めるかどうかを設定します。

引数

scaleByParts

True=1 : 決める

False=0 : 決めない

void VectorDefinition::SetScaled ( bool scaled )

矢印の長さを設定します。

引数

scaled

True=1 : 自動

False= 0 : 固定

void ResultDefinition::SetScalingFactor ( Condition * cond )

inherited

Condition オブジェクトを指定してスケーリングを設定します。

引数

cond	Condition オブジェクト

void VectorDefinition::SetSize ( Variant & size )

矢印のサイズを設定します。

引数

size	サイズ(1-100)

void VectorDefinition::SetStyle ( String & style )

矢印のタイプを設定します。

引数

style

矢印のタイプ
SimpleCone
Cone
Pyramid
Wire
Line

void ResultDefinition::SetTransparencyNonTarget ( bool on )

inherited

対象部品以外に透明度を設定します。

引数

on 透明度のオン/オフ

void ResultDefinition::SetTransparencyValueNonTarget ( Variant & value )

inherited

対象部品以外の透明度を設定します。

引数

value 透明度(0~100)

void ResultDefinition::SetUseSpecifiedPosition ( bool useSpecifiedPosition )

inherited

スケールバーの指定した位置を使用するかどうかを設定します。

引数

useSpecifiedPosition スケールバーをの位置を指定するのオン/オフ

void VectorDefinition::SetVectorType ( int type )

ベクトルタイプを指定します。

引数

type	0=総ベクトル数指定またはスキップ数指定 1=グリッドサイズまたは最小距離指定

void ResultDefinition::SetViewIndex ( Variant & index )

inherited

視点のインデックスを指定し、視点を設定します。

引数

index 視点のインデックス

void ResultDefinition::SetViewName ( Variant & name )

inherited

視点の名前を指定し、視点を設定します。

引数

name 視点の名前

void ResultDefinition::SetViewOriginalModel ( bool on )

inherited

原型図表示を設定します。

引数

on	原型図表示のオン/オフ

void ResultDefinition::SetViewPoint ( bool on )

inherited

視点を設定します。

引数

on 視点のオン/オフ

void ResultDefinition::SetViewScale ( bool on )

inherited

スケール表示を設定します。

引数

on	スケール表示のオン/オフ

公開メンバ関数

詳解

関数詳解