VectorDefinition Class Reference

VectorDefinition class is used to specify vector plots.
The class can be called from a Study class.
. More...

Inherits ResultDefinition.

Public Member Functions
void	AddCutPlane (Variant &index)
	Specifies the index or name of cutting plane. More...
void	AddPart (int partId)
	Adds a new part to the parts list for displaying vectors. More...
void	ClearCutPlanes ()
	Clears the setting of displayed cutting plane.
String	DigitsNotationTypeName ()
	Returns type of numerical value display for the indicator on the scale bar. More...
String	GetArrowCoordinateName ()
	Returns the name of the coordinate system applied to a display grid. More...
bool	GetAutoScale ()
	Returns True as a return value if the automatic scale is set. More...
StringList	GetCutPlaneList ()
	Returns the list of cutting plane index. More...
bool	GetDisplayAllParts ()
	Returns whether or not to display all parts. More...
bool	GetDisplayScaleBar ()
	Returns True if user wants to display the scale bar. More...
bool	GetDisplayShellBeam ()
	Returns whether or not to display Shell/Beam. More...
int	GetDisplayType ()
	Returns the display type. More...
bool	GetDynamicZoom ()
	Returns the status of dynamic zoom. More...
String	GetGradientName ()
	Returns the name of the gradation type as a string. More...
Variant	GetGradientNames ()
	Returns the list of the gradation types. More...
double	GetGridSize ()
	Returns grid size or minimum distance. More...
int	GetLeftPosition ()
	Returns Left position specified by the user. More...
int	GetLevels ()
	Returns the number of color levels as an integer. More...
bool	GetLogScale ()
	Returns the scaling type. If the logarithmic scale is used, True will be returned. More...
double	GetMax ()
	Returns the maximum value as a real number. More...
double	GetMin ()
	Returns the minimum value as a real number. More...
bool	GetModelCopy ()
	Returns the display flag of model copy. More...
String	GetName ()
	Returns the name of the plot as a string. More...
int	GetNumLabels ()
	Returns the number of labels in the scale bar. More...
int	GetNumSkips ()
	Returns number of skips. More...
int	GetNumVectors ()
	Returns total number of vectors. More...
String	GetPlace ()
	Returns the position of the arrow as a string. More...
Variant	GetPlaceNames ()
	Returns a list of the arrow positions. More...
String	GetResultCoordinateName ()
	Returns the coordinate system name applied to the contour display. More...
String	GetResultCoordinateNameList ()
	Returns the list of the coordinate systems which can be applied to contour. More...
virtual String	GetResultType ()
	Returns the name of the result type as a string. More...
Variant	GetResultTypeNames ()
	Returns the list of the result types. More...
bool	GetScaleByParts ()
	Returns a flag that indicates whether or not to define the scaling of the model from the minimum and maximum values. More...
bool	GetScaled ()
	Returns True as the return value when the arrow length is set automatically. More...
Condition *	GetScalingFactor ()
	Returns the scaling condition is set. More...
double	GetSize ()
	Returns the arrow size as a real number. More...
bool	GetSmooth ()
	Returns True as a return value if smoothing is set. More...
String	GetStyle ()
	Returns the type of the arrow as a string. More...
Variant	GetStyleNames ()
	Returns a list of the arrow types. More...
int	GetTopPosition ()
	Returns Top position specified by the user. More...
bool	GetTransparencyNonTarget ()
	Returns the transparency flag of non target parts. More...
int	GetTransparencyValueNonTarget ()
	Returns the transparency of non target parts. More...
bool	GetUseSpecifiedPosition ()
	Returns True if user wants to specify the position for the scale bar. More...
int	GetVectorType ()
	Returns vector type. More...
int	GetViewIndex ()
	Returns the index of view setting. More...
bool	GetViewOriginalModel ()
	Returns the display flag of original model. More...
bool	GetViewPoint ()
	Returns the view point flag. More...
bool	GetViewScale ()
	Returns the display flag of scaling. More...
bool	IsEditMode ()
	Returns whether it is in edit mode. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	Precision ()
	Returns the displayed digit that is after the decimal point. More...
void	RemoveAllParts ()
	Removes all parts from the parts list for displaying vectors.
void	SetArrow (String &style, String &place, bool scale, Variant &length)
	Specifies the argument of the arrow. More...
void	SetArrowCoordinate (Variant &name)
	Applies a coordinate system to the grid display by specifying a name. More...
void	SetAutoScale (bool scale)
	Specifies the flag for the automatic scale. More...
void	SetDigitsNotationType (Variant &type)
	Specifies the type of numerical value display for the indicator on the scale bar. More...
void	SetDisplayAllParts (bool use)
	Specifies whether or not to display all parts. More...
void	SetDisplayScaleBar (bool displayScaleBar)
	Specifies whether or not to display the scale bar. More...
void	SetDisplayShellBeam (bool isChecked)
	Specifies whether or not to display Shell/Beam. More...
void	SetDisplayType (int type)
	Specifies the display type. More...
void	SetDynamicZoom (bool zoom)
	Enables/disables dynamic zoom. More...
void	SetEditMode ()
	Specifies the edit mode for batch settings. After calling the SetEditMode function, the result item is not updated until the Update function is called.
void	SetGradient (String &name, Variant &levels, bool smooth)
	Specifies the argument to specify the color gradation. More...
void	SetGridSize (Variant &size)
	Specifies grid size or minimum distance. More...
void	SetLogScale (bool logscale)
	Specifies the scaling type. If the value is set to True , the scaling will be a logarithmic scale. More...
void	SetModelCopy (bool on)
	Specifies the display flag of model copy. More...
void	SetName (String &name)
	Specifies the name of the plot. More...
void	SetNumLabels (Variant &labels)
	Specifies the number of labels in the scale bar. More...
void	SetNumSkips (Variant &skip)
	Specifies the number of skips. More...
void	SetNumVectors (Variant &vectors)
	Specifies the total number of vectors. More...
void	SetPlace (String &place)
	Specifies the position of the arrow. More...
void	SetPrecision (Variant &precision)
	Specifies the displayed digit that is after the decimal point for the indicator on the scale bar. More...
void	SetRange (Variant &min, Variant &max)
	Specifies the range between the minimum and maximum values. More...
void	SetResultCoordinate (Variant &name)
	Returns the coordinate system name applied to the contour display. More...
virtual void	SetResultType (String &typeName, String &sourceTitle=String())
	Specifies settings for result type. More...
void	SetScaleBarPosition (Variant &leftPos, Variant &topPos)
	Specifies the scale bar position. More...
void	SetScaleByParts (bool scaleByParts)
	Specifies whether or not to define the scaling of the model from the minimum and maximum values. More...
void	SetScaled (bool scaled)
	Specifies the length of the arrow. More...
void	SetScalingFactor (Condition *cond)
	Specifies Condition object for scaling. More...
void	SetSize (Variant &size)
	Specifies the arrow size. More...
void	SetStyle (String &style)
	Specifies the type of the arrow. More...
void	SetTransparencyNonTarget (bool on)
	Specifies the transparency flag of non target parts. More...
void	SetTransparencyValueNonTarget (Variant &value)
	Specifies the transparency of non target parts. More...
void	SetUseSpecifiedPosition (bool useSpecifiedPosition)
	Specifies whether or not to use the specified position of the scale bar. More...
void	SetVectorType (int type)
	Specifies the vector type. More...
void	SetViewIndex (Variant &index)
	Specifies the index of view setting. More...
void	SetViewName (Variant &name)
	Specifies the name of view setting. More...
void	SetViewOriginalModel (bool on)
	Specifies the display flag of original model. More...
void	SetViewPoint (bool on)
	Specifies the flag of view point. More...
void	SetViewScale (bool on)
	Specifies the display flag of scaling. More...
void	Update ()
	Cancels edit mode and performs update processing. Script error when calling outside edit mode.

Detailed Description

VectorDefinition class is used to specify vector plots.
The class can be called from a Study class.
.

Example of calling the class object:

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

Member Function Documentation

void ResultDefinition::AddCutPlane ( Variant &  index )

inherited

Specifies the index or name of cutting plane.

Parameters

index

Index or name of cutting plane

void VectorDefinition::AddPart

(

int

partId

)

Adds a new part to the parts list for displaying vectors.

Parameters

partId

ID for parts

String ResultDefinition::DigitsNotationTypeName ( )

inherited

Returns type of numerical value display for the indicator on the scale bar.

Returns

Type of numerical value display
automatic ： Automatic
sientific ： Exponent display
decimal ： Decimal display

String VectorDefinition::GetArrowCoordinateName

(

)

Returns the name of the coordinate system applied to a display grid.

Returns

Name of the coordinate system

bool ResultDefinition::GetAutoScale ( )

inherited

Returns True as a return value if the automatic scale is set.

Returns

Automatic ON/OFF status of scale

StringList ResultDefinition::GetCutPlaneList ( )

inherited

Returns the list of cutting plane index.

Returns

List of cutting plane index

bool VectorDefinition::GetDisplayAllParts

(

)

Returns whether or not to display all parts.

Returns

whether or not to display all parts

bool ResultDefinition::GetDisplayScaleBar ( )

inherited

Returns True if user wants to display the scale bar.

Returns

Whether or not to display the scale bar

bool VectorDefinition::GetDisplayShellBeam

(

)

Returns whether or not to display Shell/Beam.

Returns

Whether or not to display Shell/Beam

int VectorDefinition::GetDisplayType

(

)

Returns the display type.

Returns

Display type

0 : Shaded
1 : Hidden Line
2 : Wireframe

bool VectorDefinition::GetDynamicZoom

(

)

Returns the status of dynamic zoom.

Returns

Dynamic zoom is enabled or disabled

String ResultDefinition::GetGradientName ( )

inherited

Returns the name of the gradation type as a string.

Returns

Name of the gradation type

Variant ResultDefinition::GetGradientNames ( )

inherited

Returns the list of the gradation types.

Returns

List of the gradation types

double VectorDefinition::GetGridSize

(

)

Returns grid size or minimum distance.

Returns

Grid size or minimum distance

int ResultDefinition::GetLeftPosition ( )

inherited

Returns Left position specified by the user.

Returns

Left position specified by the user

int ResultDefinition::GetLevels ( )

inherited

Returns the number of color levels as an integer.

Returns

Number of color levels

bool ResultDefinition::GetLogScale ( )

inherited

Returns the scaling type. If the logarithmic scale is used, True will be returned.

Returns

Logarithmic scale ON/OFF

double ResultDefinition::GetMax ( )

inherited

Returns the maximum value as a real number.

Returns

Maximum value

double ResultDefinition::GetMin ( )

inherited

Returns the minimum value as a real number.

Returns

Minimum value

bool ResultDefinition::GetModelCopy ( )

inherited

Returns the display flag of model copy.

Returns

Display flag of model copy

String ResultDefinition::GetName ( )

inherited

Returns the name of the plot as a string.

Returns

Plot name

int ResultDefinition::GetNumLabels ( )

inherited

Returns the number of labels in the scale bar.

Returns

Number of labels in the scale bar

int VectorDefinition::GetNumSkips

(

)

Returns number of skips.

Returns

Number of skips

int VectorDefinition::GetNumVectors

(

)

Returns total number of vectors.

Returns

Total number of vectors

String VectorDefinition::GetPlace

(

)

Returns the position of the arrow as a string.

Returns

Position of the arrow

Variant VectorDefinition::GetPlaceNames

(

)

Returns a list of the arrow positions.

Returns

List of the arrow positions

String ResultDefinition::GetResultCoordinateName ( )

inherited

Returns the coordinate system name applied to the contour display.

Returns

Name of the coordinate system

String ResultDefinition::GetResultCoordinateNameList ( )

inherited

Returns the list of the coordinate systems which can be applied to contour.

Returns

List of the coordinate systems

String ResultDefinition::GetResultType ( )

virtualinherited

Returns the name of the result type as a string.

Returns

Name of the result type

Reimplemented in FluxLineDefinition.

Variant ResultDefinition::GetResultTypeNames ( )

inherited

Returns the list of the result types.

Returns

List of the result types

bool VectorDefinition::GetScaleByParts

(

)

Returns a flag that indicates whether or not to define the scaling of the model from the minimum and maximum values.

Returns

Whether or not to determine the scaling of the model from the minimum and maximum values

bool VectorDefinition::GetScaled

(

)

Returns True as the return value when the arrow length is set automatically.

Returns

If the arrow length is automatically set or not

Condition * ResultDefinition::GetScalingFactor ( )

inherited

Returns the scaling condition is set.

Returns

Condition object

double VectorDefinition::GetSize

(

)

Returns the arrow size as a real number.

Returns

Arrow size(1-100)

bool ResultDefinition::GetSmooth ( )

inherited

Returns True as a return value if smoothing is set.

Returns

Smoothing ON/OFF

String VectorDefinition::GetStyle

(

)

Returns the type of the arrow as a string.

Returns

Arrow type
SimpleCone
Cone
Pyramid
Wire
Line

Variant VectorDefinition::GetStyleNames

(

)

Returns a list of the arrow types.

Returns

List of arrow types

int ResultDefinition::GetTopPosition ( )

inherited

Returns Top position specified by the user.

Returns

Top position specified by the user

bool ResultDefinition::GetTransparencyNonTarget ( )

inherited

Returns the transparency flag of non target parts.

Returns

Transparency

int ResultDefinition::GetTransparencyValueNonTarget ( )

inherited

Returns the transparency of non target parts.

Returns

Transparency

bool ResultDefinition::GetUseSpecifiedPosition ( )

inherited

Returns True if user wants to specify the position for the scale bar.

Returns

Whether or not to use the position specifed by the user

int VectorDefinition::GetVectorType

(

)

Returns vector type.

Returns

Vector type
0=Specify total number of vectors or number of skips
1=Specify grid size or minimum distance

int ResultDefinition::GetViewIndex ( )

inherited

Returns the index of view setting.

Returns

Index of view setting

bool ResultDefinition::GetViewOriginalModel ( )

inherited

Returns the display flag of original model.

Returns

Display flag of original model

bool ResultDefinition::GetViewPoint ( )

inherited

Returns the view point flag.

Returns

View point flag

bool ResultDefinition::GetViewScale ( )

inherited

Returns the display flag of scaling.

Returns

Display flag of scaling

bool ResultDefinition::IsEditMode ( )

inherited

Returns whether it is in edit mode.

Returns

Whether in edit mode

bool ResultDefinition::IsValid ( )

inherited

Returns True if an object is valid.

Returns

Whether or not the ResultDefinition objects in the list are valid

int ResultDefinition::Precision ( )

inherited

Returns the displayed digit that is after the decimal point.

Returns

Display digit after the decimal point

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

Specifies the argument of the arrow.

Parameters

style	Type
place	Position
scale	Length
length	Size

void VectorDefinition::SetArrowCoordinate

(

Variant &

name

)

Applies a coordinate system to the grid display by specifying a name.

Parameters

name	Name or index of the coordinate system

void ResultDefinition::SetAutoScale ( bool  scale )

inherited

Specifies the flag for the automatic scale.

Parameters

scale

ON/OFF

void ResultDefinition::SetDigitsNotationType ( Variant &  type )

inherited

Specifies the type of numerical value display for the indicator on the scale bar.

Parameters

type	Type of numerical value display automatic ： Automatic sientific ： Exponent display decimal ： Decimal display

void VectorDefinition::SetDisplayAllParts

(

bool

use

)

Specifies whether or not to display all parts.

Parameters

use	True=1 : [Display on All Parts] is enabled False=0 : [Display on All Parts] is disabled

void ResultDefinition::SetDisplayScaleBar ( bool  displayScaleBar )

inherited

Specifies whether or not to display the scale bar.

Parameters

displayScaleBar

Flag for whether or not to display the scale bar.

void VectorDefinition::SetDisplayShellBeam

(

bool

isChecked

)

Specifies whether or not to display Shell/Beam.

Parameters

isChecked

True=1 : [Display Shell/Beam] is active False=0 : [Display Shell/Beam] is not active

void VectorDefinition::SetDisplayType

(

int

type

)

Specifies the display type.

Parameters

type	0 : Shaded 1 : Hidden Line 2 : Wireframe

void VectorDefinition::SetDynamicZoom

(

bool

zoom

)

Enables/disables dynamic zoom.

Parameters

zoom	True=1 : Dynamic zoom is enabled False=0 : Dynamic zoom is disabled

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

inherited

Specifies the argument to specify the color gradation.

Parameters

name	Gradation: PurpleRed BlueRed GrayScale CMR
levels	Number of levels
smooth	Smooth color band

void VectorDefinition::SetGridSize

(

Variant &

size

)

Specifies grid size or minimum distance.

Parameters

size	Grid size or minimum distance

void ResultDefinition::SetLogScale ( bool  logscale )

inherited

Specifies the scaling type. If the value is set to True , the scaling will be a logarithmic scale.

Parameters

logscale

True=1 : Logarithmic scale False=0 : Linear scale

void ResultDefinition::SetModelCopy ( bool  on )

inherited

Specifies the display flag of model copy.

Parameters

on	Display flag of model copy

void ResultDefinition::SetName ( String &  name )

inherited

Specifies the name of the plot.

Parameters

name

Plot name

void ResultDefinition::SetNumLabels ( Variant &  labels )

inherited

Specifies the number of labels in the scale bar.

Parameters

labels

Number of labels

void VectorDefinition::SetNumSkips

(

Variant &

skip

)

Specifies the number of skips.

Parameters

skip	Number of skips

void VectorDefinition::SetNumVectors

(

Variant &

vectors

)

Specifies the total number of vectors.

Parameters

vectors

Number of vectors

void VectorDefinition::SetPlace

(

String &

place

)

Specifies the position of the arrow.

Parameters

place

Position of the arrow

void ResultDefinition::SetPrecision ( Variant &  precision )

inherited

Specifies the displayed digit that is after the decimal point for the indicator on the scale bar.

Parameters

Precision

Display digit after the decimal point

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

inherited

Specifies the range between the minimum and maximum values.

Parameters

min	Minimum value
max	Maximum value

void ResultDefinition::SetResultCoordinate ( Variant &  name )

inherited

Returns the coordinate system name applied to the contour display.

Parameters

name	Name or index of the coordinate system

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

virtual

Specifies settings for result type.

Parameters

typeName	Result type name
sourceTitle	Title of the result calculation process, such as Fourier transform, when referencing a calculation tool.

The argument "sourceTitle" can be omitted.
For information about the names of condition types that can be specified as the argument "typeName", see Properties and Flags for Calculating Results .

Reimplemented from ResultDefinition.

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

inherited

Specifies the scale bar position.

Parameters

leftPos	Position of the scale bar starting from the left
topPos	Position of the scale bar starting from the bottom

void VectorDefinition::SetScaleByParts

(

bool

scaleByParts

)

Specifies whether or not to define the scaling of the model from the minimum and maximum values.

Parameters

scaleByParts

True=1 : Determines from the minimum and maximum values False=0 : Does not determine from the minimum and maximum values

void VectorDefinition::SetScaled

(

bool

scaled

)

Specifies the length of the arrow.

Parameters

scaled

True=1 : Automatic False= 0 : Fixed

void ResultDefinition::SetScalingFactor ( Condition *  cond )

inherited

Specifies Condition object for scaling.

Parameters

cond	Condition object

void VectorDefinition::SetSize

(

Variant &

size

)

Specifies the arrow size.

Parameters

size	Size(1-100)

void VectorDefinition::SetStyle

(

String &

style

)

Specifies the type of the arrow.

Parameters

style

Arrow type SimpleCone Cone Pyramid Wire Line

void ResultDefinition::SetTransparencyNonTarget ( bool  on )

inherited

Specifies the transparency flag of non target parts.

Parameters

on	Transparency on/off

void ResultDefinition::SetTransparencyValueNonTarget ( Variant &  value )

inherited

Specifies the transparency of non target parts.

Parameters

value

Transparency(0~100)

void ResultDefinition::SetUseSpecifiedPosition ( bool  useSpecifiedPosition )

inherited

Specifies whether or not to use the specified position of the scale bar.

Parameters

useSpecifiedPosition

Flag for whether or not to use the specified position of the scale bar.

void VectorDefinition::SetVectorType

(

int

type

)

Specifies the vector type.

Parameters

type	0=Specifies total number of vectors or number of skips 1=Specifies grid size or minimum distance

void ResultDefinition::SetViewIndex ( Variant &  index )

inherited

Specifies the index of view setting.

Parameters

index

Index of view setting

void ResultDefinition::SetViewName ( Variant &  name )

inherited

Specifies the name of view setting.

Parameters

name	Name of the view setting

void ResultDefinition::SetViewOriginalModel ( bool  on )

inherited

Specifies the display flag of original model.

Parameters

on	Display flag of original model

void ResultDefinition::SetViewPoint ( bool  on )

inherited

Specifies the flag of view point.

Parameters

on	Flag of view point

void ResultDefinition::SetViewScale ( bool  on )

inherited

Specifies the display flag of scaling.

Parameters

on	Display flag of scaling