CAE VectorPlot
xShowCAEVectorPlot
Sets vector plot display state.
void xShowCAEVectorPlot (String sModel, bool sShowVectorPlot)
sModel
Reserved for future use. Can be ignored now by passing an empty string.
sShowVectorPlot
Set TRUE to display vector plot.
xIsCAEVectorPlotVisible
Gets display state of vector plot.
bool xIsCAEVectorPlotVisible (String sModel)
return
Returns TRUE, if vector plot is displayed.
sModel
Reserved for future use. Can be ignored now by passing an empty string.
xSetCAEVectorPlotAutoScale
Sets Vectorplot auto scale flag to On or Off for the given CAE model.
bool xSetCAEVectorPlotAutoScale(String sModel, bool bAutoScale)
return
Returns True if sets the flag successfully.
Returns False otherwise.
sModel
CAE Model Name
bAutoScale
True - enables auto scale
False - disables auto scale.
xGetCAEVectorPlotAutoScale
Gets Vectorplot auto scale flag for the given CAE model.
bool xGetCAEVectorPlotAutoScale(String sModel)
return
Returns True or False flag based on the vectorplot settings.
sModel
CAE Model Name
xSetCAEVectorPlotArrowSize
Sets Vectorplot arrow size value for the given CAE model.Arrow size varies between 1 and 5.
bool xSetCAEVectorPlotArrowSize(String sModel, int iSize)
return
Returns True if successfully sets the arrow size.
Returns False otherwise.
sModel
CAE Model Name
iSize
Size of the arrow should be between 1 and 5. The value less than 1 or greater than 5 will be ignored.
xGetCAEVectorPlotArrowSize
Gets Vectorplot arrow size value for the given CAE model.
int xGetCAEVectorPlotArrowSize(String sModel)
return
Returns an integer value between 1 and 5.
sModel
CAE Model Name
xSetCAEVectorPlotUserColorMode
Sets Vectorplot user color flag for the given CAE model.
bool xSetCAEVectorPlotUserColorMode(String sModel, bool bUserColor)
return
Returns True if successfully sets user color flag.
Returns False otherwise.
sModel
CAE Model Name
bUserColor
True - displays the vectors in user defined color.
False - displays the vectors in contour color based on its position and value.
xGetCAEVectorPlotUserColorMode
Gets Vectorplot user color flag for the given CAE model.
bool xGetCAEVectorPlotUserColorMode(String sModel)
return
Returns True if the CAE Vectorplot user color flag is On.
Returns False otherwise.
sModel
CAE Model Name
xSetCAEVectorPlotScaleFactor
Sets Vectorplot scale factor value for the given CAE model.
bool xSetCAEVectorPlotScaleFactor(String sModel, float fScale)
return
Returns True if successfully sets scale factor value.
Returns False otherwise.
sModel
CAE Model Name
fScale
scale factor value.
xGetCAEVectorPlotScaleFactor
Gets Vectorplot scale factor value for the given CAE model.
float xGetCAEVectorPlotScaleFactor(String sModel)
return
Returns the scale factor value, a real number.
sModel
CAE Model Name
xSetVectorPlotFilter
Sets vector plot filter data for the given CAE Model.
bool xSetVectorPlotFilter(String sModel, int iType, float fZoneRadius, List<String> nodeSetNames, int iNodesetMask);
return
Returns True if successfully sets the filter data the vector plot of the given model.
Returns False otherwise.
sModel
CAE Model Name
iType
Filter type
0 - No Filter
1 - Using Zone Radius
2 - Using Nodesets
3 - Using percentage
fZoneRadius
This variable is used as zone radius or percentage based of the filter type.
nodeSetNames
list of nodeSetNames available in the model.
iNodesetMask
For future work.
0 - Mask the given nodesets.
1 - Inverse nodeset masking.
2 - Using Nodeset Manager Mask.
pxGetVectorPlotFilter
Gets the filter data used in vector plot.
List<float> pxGetVectorPlotFilter(String sModel)
return
Returns array of size 2.
array[0] - filter type.
array[1] - filter factor (zone radius / percentage).
sModel
CAE Model Name
pxGetVectorPlotFilterEx
Gets the nodeset names used in the given model.
List<String> pxGetVectorPlotFilterEx(String sModel)
return
Returns list of nodeset names.
sModel
CAE Model Name
xSetCAEVectorPlotUniformLengthMode
Sets uniform length mode and displays vector plot with default fixed length if the flag is true.
bool xSetCAEVectorPlotUniformLengthMode(String sModel, bool bUniformLength);
return
Returns True if successfully sets the flag to the vector plot.
Return False otherwise.
sModel
CAE Model Name
bUniformLength
Enables/Disables uniform length mode.
True - fixed length for all vectors.
False - each vector length is based on vector magnitude and scale factor.
xIsCAEVectorPlotUniformLengthMode
Gets the info if vector plot is in uniform length mode or not for the given CAE model.
bool xIsCAEVectorPlotUniformLengthMode(String sModel);
return
Returns True the vector plot is in uniform length.
Return False otherwise.
sModel
CAE Model Name
xSetCAEVectorPlotUniformLength
Sets user defined fixed length to vector plot.
bool xSetCAEVectorPlotUniformLength(String sModel, float fLength);
return
Returns True if successfully sets length to the vector plot.
Return False otherwise.
sModel
CAE Model Name
fLength
Fixed length to be set to vectors.
xGetCAEVectorPlotUniformLength
Gets the fixed length used in vector plot.
float xGetCAEVectorPlotUniformLength(String sModel);
return
Returns fixed length of the vectors.
sModel
CAE Model Name