SymbolPlot

xCreateNewSymbolPlot

Creates a symbol plot with a given name for a given CAE model.

bool xCreateNewSymbolPlot(StringsModel, StringsPlotName)

return

Returns True, if a new symbol plot with the specified name is created successfully.

Returns False, if no such CAE model or symbol plot name exists.

sModel

CAE Model name.

sPlotName

Symbol Plot Name.

xDeleteSymbolPlot

Deletes the symbol plot associated with a plot name.

bool xDeleteSymbolPlot(String sModel, String sPlotName)

return

Returns True, if the specified symbol plot is deleted successfully.

Returns False, if no such CAE model or symbol plot name exists.

sModel

CAE Model name.

sPlotName

Symbol Plot Name.

xClearSymbolPlot

Clears all data of a particular symbol plot, associated with the given name.

bool xClearSymbolPlot(String sModel, String sPlotName)

return

Returns True, if symbols of specific symbol plot are cleared successfully.

Returns False, if no such CAE model or symbol plot name exists.

sModel

CAE Model name.

sPlotName

Symbol Plot Name.

xGetCurSymbolPlotName

Gets current symbol plot.

String xGetCurSymbolPlotName(String sModel)

return

Returns empty String if there no current symbol plot.

Returns current symbol plot name.

sModel

CAE Model name.

xSetCurSymbolPlotName

Sets a symbol plot as current plot.

bool xSetCurSymbolPlotName(String sModel, String sPlotName)

return

Returns True, if the specified symbol plot is set as the current symbol plot successfully.

Returns False, if no such CAE model or symbol plot name exists.

sModel

CAE Model name.

sPlotName

Symbol Plot Name.

xSetSymbolPlotVectorType

Sets Symbol plot vector type.

bool xSetSymbolPlotVectorType(int iType)

return

Returns True if Successful.

iType

Type of symbol.

xAddSymbolPlotNodeSets

Adds set of node IDs to the Nodeset Name.

bool xAddSymbolPlotNodeSets(String sModel, String sNodeSet, String idList)

return

Returns True if successful.

sModel

CAE Model Name.

sNodeSet

Nodeset Name.

idList

Node ID array.

xSetSymbolPlotResultAttrib

Sets required attributes to create symbols.

bool xSetSymbolPlotResultAttrib(String sModel, String sResult, String sInstance, StringsDerived, String sComplexComp, float fAngle)

return

Returns True if successful.

sModel

CAE model name.

sResult

User-selected CAE result.

sInstance

User-selected CAE result Instance.

sDerived

User selected CAE scalar/derived type

sComplexComp

Complex component. This is valid only if the selected result is of Complex Eigen type.

fAngle

Complex phase angle. This is valid only if the selected result is of Complex Eigen type.

xApplySymbolPlotNodeSets

Apply the nodesets for symbol plot creation.

bool xApplySymbolPlotNodeSets(String sModel, String sNodeSets)

return

Returns True if successful.

sModel

CAE Model Name.

sNodeSets

Nodeset Name list.

xSetSymbolPlotVisibility

Sets the visibility of a particular symbol plot.

bool xSetSymbolPlotVisibility(String sModel, String sPlotName, bool bShow)

return

Returns True, if successfully sets the symbol plot visibility.

Returns False, if no such CAE model or symbol plot name exists.

sModel

CAE Model name.

sPlotName

Symbol Plot Name.

bShow

Visibility flag.

pxGetSymbolPlotNames

Gets all the symbol plot names for the given CAE model.

List<String> pxGetSymbolPlotNames(String sModel)

return

Returns all symbol plot names in an array.

sModel

CAE Model name.

xGetSymbolPlotVectorType

Gets Symbol plot vector type.

int xGetSymbolPlotVectorType()

return

Returns the type of vector symbol.

pxGetSymbolPlotNodeSets

Gets the array of symbol plot nodeset names.

List<String> pxGetSymbolPlotNodeSets(String sModel)

return

Returns the Nodeset names in an array.

sModel

CAE Model Name.

pxGetSymbolPlotAttribs

Gets all attributes and set the current symbol plot.

List<String> pxGetSymbolPlotAttribs(String sModel)

return

Returns all String attributes into an array, in a size of 3.

retArray[0] = CAE Result
retArray[1] = CAE Derived result
retArray[2] = Complex Component

sModel

CAE Model name.

xGetSymbolPlotComplexAngle

Gets Complex angle attribute and set the current symbol plot.

float xGetSymbolPlotComplexAngle(String sModel)

return

Returns the complex angle in degrees.

sModel

CAE Model Name.

pxGetSymbolPlotNodeSetIDList

Gets Node ID list for the given CAE Model and NodeSet.

List<int> pxGetSymbolPlotNodeSetIDList(String sModel, String sNodeSet)

return

Returns array of node ids.

sModel

CAE Model Name.

sNodeSet

Nodeset Name.

xGetSymbolPlotShapeType

Gets symbol plot shape type.

int xGetSymbolPlotShapeType(String sModel)

return

Returns True, if successful.

sModel

CAE Model Name.

xGetSymbolPlotLengthFactor

Gets the symbol plot length factor.

float xGetSymbolPlotLengthFactor(String sModel)

return

Returns the symbol plot length scale factor.

sModel

CAE Model name.

xGetSymbolPlotWidthFactor

Gets the symbol plot width factor.

float xGetSymbolPlotWidthFactor(String sModel)

return

Returns the symbol plot width scale factor.

sModel

CAE Model.

pxGetSymbolPlotColor

Gets symbol plot color in the form of RGB coefficients.

List<float> pxGetSymbolPlotColor(String sModel)

return

Returns color coefficients into array of size 3.

retArray[0]= coefficent for Red (0 to 1)
retArray[1]= coefficent for Green (0 to 1)
retArray[2]= coefficent for Blue (0 to 1)

sModel

CAE Model Name.

xSetSymbolPlotShapeType

Sets Symbol plot dimension type.

bool xSetSymbolPlotShapeType(String sModel, int iType)

return

Returns True, if successful.

sModel

CAE Model Name.

iType

Dimension type (2D Symbol or 3D Symbol).

xSetSymbolPlotLengthFactor

Sets the symbol plot length factor.

bool xSetSymbolPlotLengthFactor(String sModel, float fLength)

return

Returns True, if successful

sModel

CAE Model name.

fLength

Length scale factor.

xSetSymbolPlotWidthFactor

Sets the symbol plot width factor. The default scale factor is 1.

bool xSetSymbolPlotWidthFactor(String sModel, float fWidth)

return

Returns True, if successful

sModel

CAE Model name.

fWidth

Width scale factor.

xSetSymbolPlotColor

Sets symbol color.

bool xSetSymbolPlotColor(String sModel, float fR, float fG, float fB)

return

Returns True, if successful.

sModel

CAE Model Name.

fR

Coefficient for Red (0 to 1).

fG

Coefficient for Green (0 to 1).

fB

Coefficient for Blue (0 to 1).

pxCreateConstraintSymbolPlot

Creates a new symbol plot for all constraint nodes of a particular instance. This function considers visible parts for constraint symbol creation.

List<String> pxCreateConstraintSymbolPlot(String sModel, String sInstance)

return

Returns constraint plot name list created from constraint result and valid constraint nodes.

Returns empty list, if there is no constraint data.

sModel

CAE model name.

sInstance

Instance Name.

xCreatePressureSymbolPlot

Creates a new symbol plot for the pressure applied elements of a particular instance. This function considers visible parts for constraint symbol creation.

String xCreatePressureSymbolPlot(String sModel, String sInstance)

return

Returns symbol plot name created from Pressure Loads result and valid nodes.

Returns empty name, if there is no pressure symbol data.

sModel

CAE model name.

sInstance

Instance Name.

xGetConstraintName

Gets CAE Constraint or Single Point Constraint (SPC) Name of CAE Model.

String xGetConstraintName(String sModel)

return

Returns CAE constraint name is available for the sModel. Returns empty String if not.

sModel

CAE model name.

xGetCurSymbolPlotViewMode

Gets current symbol plot view mode.

int xGetCurSymbolPlotViewMode(String sModel)

return

Returns current plot view mode as an integer.

0 - if view mode is "Auto", default
1 - if view mode is "From Position"
2 - if view mode is "To Position"
3 - if view mode is "Resultant"

sModel

CAE Model name

xSetCurSymbolPlotViewMode

Gets current symbol plot view mode.

bool xSetCurSymbolPlotViewMode(String sModel, int iMode)

return

Returns True, if the mode is successful set to Current symbol plot.

sModel

CAE Model name.

iMode

View mode is an integer between 0 to 3.

0 - for view mode "Auto", default
1 - for view mode "From Position"
2 - for view mode "To Position"
3 - for view mode "Resultant"

xSetSymbolPlotUserColorMode

Sets User Color mode to the given Symbol plot of given CAE Model.

bool xSetSymbolPlotUserColorMode(String sModel, String sPlotName, bool bUserColor);

return

Returns True if successfully sets the flag to the model.

Returns False otherwise

sModel

CAE Model Name

sPlotName

Symbol plot name

bUserColor

Sets User Color if this flag is True.

Sets Contour Color otherwise.

xGetSymbolPlotUserColorMode

Gets User Color Mode flag for the given symbol plot of the given CAE model.

bool xGetSymbolPlotUserColorMode(String sModel, String sPlotName);

return

Returns True if the given symbol plot is in user color.

Returns False otherwise.

sModel

CAE Model Name

sPlotName

Symbol plot name

xReverseSymbolPlot

Sets Reverse flag to the given symbol plot.

bool xReverseSymbolPlot(String sModel, String sSymbolPlot, bool bReverse)

return

Returns True if it succeeds.

Returns False otherwise.

sModel

CAE Model Name

sSymbolPlot

Symbol Plot Name

bReverse

True - Reverses the symbols

False - Regular Symbols.

xIsSymbolPlotReversed

Checks if the given symbol plot is reversed or not and returns a flag.

bool xIsSymbolPlotReversed(String sModel, String sSymbolPlot)

return

Returns True if symbols are reversed.

Returns False otherwise.

sModel

CAE Model Name

sSymbolPlot

Symbol Plot Name