CAE ProbeEx
xGetCAEModelVolume
Gets surface bounded volume of a given model in a given instance.
float xGetCAEModelVolume(String sModel, String sInstance)
return
Returns bound volume.
If -1 is returned, it is moving mesh data. In this version only the
current instance is supported. sInstance has to be same as current
instance applied for the model.
For any other negative value it failes.
sModel
CAE Model Name.
sInstance
Instance Name of Deformation result.
xGetCAEModelSurfaceArea
Gets surface area of a given model in a given instance.
float xGetCAEModelSurfaceArea(String sModel, String sInstance)
return
Returns surface area.
If -1 is returned, it is moving mesh data. In this version only the
current instance is supported. sInstance has to be same as current
instance applied for the model.
For any other negative value it failes.
sModel
CAE Model Name.
sInstance
Instance name of deformation result.
xGetCAEProbeLabelDefaultFontName
Gets default font face name for given celltype.
String xGetCAEProbeLabelDefaultFontName(String sModel, int iCellType)
return
Returns default font name of the given cell type.
sModel
CAE Model Name.
iCellType
Type of cell.
0 - Header Type
1 - Value Type
-1 - Both
xGetCAEProbeLabelDefaultFontSize
Gets default font size for given celltype.
int xGetCAEProbeLabelDefaultFontSize(String sModel, int iCellType)
return
Returns default font name of the given cell type.
sModel
CAE Model Name.
iCellType
Type of cell.
0 - Header Type
1 - Value Type
-1 - Both
xSetCAEProbeLabelDefaultFontName
Sets font name as default to the label cell type given.
bool xSetCAEProbeLabelDefaultFontName(String sModel, String sFontFace, int iCellType)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name.
sFontFace
Font Name.
iCellType
Type of cell.
0 - Header Type
1 - Value Type
-1 - Both
xSetCAEProbeLabelDefaultFontSize
Sets font size as default to the label cell type given.
bool xSetCAEProbeLabelDefaultFontSize(String sModel, int iSize, int iCellType)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name.
iSize
Default font size
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
pxGetCAEProbeLabelDefaultNumericalFormat
Gets default numerical formats, i.e., precision and scientific format flag.
List<int> pxGetCAEProbeLabelDefaultNumericalFormat(String sModel)
return
Returns two integers in an array.
retArray[0] = precision places
retArray[1] = scientific format flag
sModel
CAE Model Name.
xSetCAEProbeLabelDefaultNumericalFormat
Sets default numerical formats, i.e., precision and scientific format flag.
bool xSetCAEProbeLabelDefaultNumericalFormat(String sModel, int iPrecision, bool bScientific)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name
iPrecision
Number of decimal places.
bScientific
True – enables scientific format.
False – enables decimal format.
pxGetCAEProbeLabelDefaultTextColor
Gets default text color of the cell type.
List<float> pxGetCAEProbeLabelDefaultTextColor (String sModel, int iCellType)
return
Return three real values in an array.
retArray[0] = red color coefficent
retArray[1] = green color coefficent
retArray[2] = blue color coefficent
sModel
CAE Model Name.
iCellType
Type of cell.
0 - Header Type
1 - Value Type
-1 - Both
xSetCAEProbeLabelDefaultTextColor
Sets default text color to the cell type.
bool xSetCAEProbeLabelDefaultTextColor (String sModel, int iCellType , float r, float g, float b)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
r
Red color coefficient.
g
Green color coefficient.
b
Blue color coefficient.
pxGetCAEProbeLabelDefaultBackground
Gets default background flag and color of the cell type.
List<float> pxGetCAEProbeLabelDefaultBackground(String sModel, int iCellType)
return
Returns real values of array size 4.
retArray[0] = 0 / 1 (background boolean flag)
retArray[1] = Red color coefficient
retArray[2] = Green color coefficient
retArray[3] = Blue color coefficient
sModel
CAE Model Name.
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
xSetCAEProbeLabelDefaultBackground
Sets default background flag and color to the cell type.
Bool xSetCAEProbeLabelDefaultBackground(String sModel, int iCellType, bool bON, float r, float g, float b)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
bON
On/off flag.
r
Red color coefficient.
g
Green color coefficient.
b
Blue color coefficient.
pxGetCAEProbeLabelDefaultDisplayFlags
Gets default display flags, i.e., ID, row header, column header and part header.
List<int> pxGetCAEProbeLabelDefaultDisplayFlags(String sModel)
return
returns an array of display flag as integers (0 or 1)
retArray[0] = ID label
retArray[1] = Row header
retArray[2] = Column header
retArray[3] = Part header
sModel
CAE Model Name.
xSetCAEProbeLabelDefaultDisplayFlags
Sets default display flags, i.e., ID, row header, column header and part header.
bool xSetCAEProbeLabelDefaultDisplayFlags(String sMode, bool bID, bool bRowHeader, bool bColumnHeader, bool bPartHeader)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name.
bID
ID label flag.
bRowHeader
Row header flag.
bColumnHeader
Column header flag.
bPartHeader
Part header flag.
xGetCAEProbeLabelDefaultAlignment
Gets default cell alignment.
int xGetCAEProbeLabelDefaultAlignment(String sModel, int iCellType)
return
Returns alignment as an integer
0 – Left Alignment
1 – Middle Alignment
2 - Right Alignment
sModel
CAE Model Name.
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
xSetCAEProbeLabelDefaultAlignment
Sets default cell alignment.
bool xSetCAEProbeLabelDefaultAlignment(String sModel, int iCellType, int iAlign)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name.
iCellType
Type of cell
0 - Header Type
1 - Value Type
-1 - Both
iAlign
0 – Left Alignment
1 – Middle Alignment
2 - Right Alignment
xUpdateCAEProbeTableDefaults
Updates the defaults to the probe labels of the given model. If the model name is empty, all models will be updated.
bool xUpdateCAEProbeTableDefaults (String sModel)
return
Returns True, if it succeeds.
Returns False, if it fails.
sModel
CAE Model Name.
(If model name is empty, all models will be updated.)
xGetProbedPart
Gets the part name of given probe table ID and CAE model.
String xGetProbedPart(String sModel, size_t iProbeTableID)
return
Returns part name associated with probe table ID and model.
sModel
CAE model name.
iProbeTableID
Probe table ID.
xShowHideAllProbeLabels
Sets visiblity state of all probe tables.
void xShowHideAllProbeLabels(bool bShow)
return
None.
bShow
Set True to show all probe tables. False hides all probe tables.
pxGetAllUser3DProbeTable
Gets all user created 3D probe tables IDs in an array.
List<size_t> pxGetAllUser3DProbeTable(String sModel)
return
Returns user 3D probe table’s ID in an array.
sModel
Model name.
xAdd3DProbeTable
Adds user defined ProbeTable to a nodeID.
size_t xAdd3DProbeTable(StringsModel, String sPart, size_t iNodeID, int iRow, int iCol)
return
Returns TableID.
sModel
Model name.
sPart
Part name.
iNodeID
Node ID.
iRow, iCol
Number of Rows and columns to be created.
pxGetProbeTableBoundBox
Get bounding box of all probe tables in world coordinate system.
List<float> pxGetProbeTableBoundBox(String sModel)
return
If success returns array of size 6.
retArray[0] = Minimum bound X position
retArray[1] = Minimum bound Y position
retArray[2] = Minimum bound Z position
retArray[3] = Maximum bound X position
retArray[4] = Maximum bound Y position
retArray[5] = Maximum bound Z position
sModel
Model name. Empty String gets bound box from all models.
pxGetProbeTableBoundSphere
Get bounding sphere of all probe tables in world coordinate system.
List<float> pxGetProbeTableBoundSphere(String sModel)
return
If success returns array of size 4.
retArray[0] = Bounding sphere center X position
retArray[1] = Bounding sphere center Y position
retArray[2] = Bounding sphere center Z position
retArray[3] = Bounding sphere radius
sModel
Model name. Empty String gets bound sphere from all models.
pxGetBestViewForTables
Gets best view for set of probe tables.
List<float> pxGetBestViewForTables(String sModel, List<size_t> tableIDArray)
Return
If success, Returns camera view info in an array of size 13.
retArray[0], retArray[1], retArray[2] Camera XYZ positions
retArray[3], retArray[4], retArray[5] Camera direction
retArray[7], retArray[8], retArray[9] Camera upVector
retArray[9] FOVy value in Radians
retArray[10] AspectRatio
retArray[11] NearClipDistance
retArray[12] FarClipDistance
sModel
Model name.
tableIDArray
TableIDs array for wish best view is needed.
pxGetIDInfoForLocation
Get Node ID and Element ID for a nearest coordinates given.
List<long> pxGetIDInfoForLocation(String sModel, String sPart, float x, float y, float z)
return
If successful, returns NodeD and Element IDs in an array of size 2.
If fails, returns empty array or ID values as -1.
sModel
Model Name.
sPart
Part name.
x, y, z
Coordinate postion for the nearest node.
pxGetPrincipalDirections
Get three principal direction vectors at the given node/element ID, model, result and instance.
List<float> pxGetPrincipalDirections(String sModel, String sResult, String sInstance, int iID)
return
Returns an empty array, if failed
Returns an array of 9 float values, if success.
retArray[0], retArray[1], retArray[2] refers to Max Principal vector
retArray[3], retArray[4], retArray[5] refers to Min Principal vector
retArray[6], retArray[7], retArray[8] refers to Mid Principal vector
sModel
CAE Model Name.
sResult
Tensor Result name.
sInstance
CAE Result instance name.
iID
Node or elment ID.
pxGetTransformedResult
Gets transformed result vector for the given model, result, instance and ID with respect to given coordinate systems.
List<float> pxGetTransformedResult(String sModel, String sResult, String sInstance, int iID, List<float> coordSys)
return
Returns an empty array if failed.
Returns an array values of size 3 or 6 based on the given input result type.
sModel
CAE Model Name.
sResult
Tensor Result name.
sInstance
CAE Result instance name.
iID
Node or elment ID.
coordSys
An array of 9 or 12 values referring to Origin, X, Y and Z axes.
(retArray[0], retArray[1], retArray[2]) = Origin point
(retArray[3], retArray[4], retArray[5]) = X Axis vector
(retArray[6], retArray[7], retArray[8]) = Y Axis vector
(retArray[9], retArray[10],retArray[11])= Z Axis vector (optional)
pxGetTransformedValues
Gets transformed values for the given vector or tensor with respect to given coordinate systems.
List<float> pxGetTransformedValues(List<float> result, List<float> coordSys)
return
Returns an empty array if failed.
Returns an array values of size 3 or 6 based on the given input result vector size.
result
Result vector.
coordSys
An array of 9 or 12 values referring to Origin, X, Y and Z axes.
(retArray[0], retArray[1], retArray[2]) = Origin point
(retArray[3], retArray[4], retArray[5]) = X Axis vector
(retArray[6], retArray[7], retArray[8]) = Y Axis vector
(retArray[9], retArray[10],retArray[11])= Z Axis vector (optional)
pxGetIDsInLocalBox
Constructs a new coordinate system at the location of given node ID and constructs bounding box axis aligned to the coordinate system. Then IDs lies within the bound box are stored into an array and returns.
List<int> pxGetIDsInLocalBox(String sModel, String sPartName, int iID, List<float> boundBox, List<float> coordSys)
return
Returns an empty array, if failed
Returns an array of IDs(int) of which bound box contains.
sModel
CAE Model Name.
sPartName
Part Name.
iID
Node ID.
boundBox
An array of 3 values. Lengths of bound box in the 3 axes of local coord system.
coordSys
An array of 9 or 12 values referring to Origin, X, Y and Z axes.
(retArray[0], retArray[1], retArray[2]) = Origin point
(retArray[3], retArray[4], retArray[5]) = X Axis vector
(retArray[6], retArray[7], retArray[8]) = Y Axis vector
(retArray[9], retArray[10],retArray[11])= Z Axis vector (optional)
pxGetCAEPartFeatureEdgeNodes
Gets nodal connectivity for part feature edges.
List <size_t> pxGetCAEPartFeatureEdgeNodes(String sModel, String sPart)
return
Returns an array of node ids which falls on the feature edges of the given part.
sModel
Model name.
sPart
Part Name, to which feature edge nodal connectivity to be found.
pxGetCAEPartNodes
Gets nodal connectivity for part.
List <size_t> pxGetCAEPartNodes(String sModel, String sPart, bool bUniqueNodes)
return
Returns an array of Node IDs.
Returns empty array if failed.
sModel
Model name.
sPart
Part Name, to which nodal connectivity to be found.
bUniqueNodes
Returns ID array without duplication if this flag is True.
Returns ID array with duplicates if this flag is False.
pxGetEdgeAdjacentElements
Gets edge adjacent elements.
Input: Edge connectivity nodes list ( [N1,N2,N2,N3,N3,N5...] )
Output: Element ids associated with input edges.
List <size_t> pxGetEdgeAdjacentElements(String sModel, String sPart, List <size_t> edgeNodes)
return
Returns an array of element ids.
Returns empty array if failed.
sModel
Model name.
sPart
Part Name, to which nodal connectivity to be found.
edgeNodes
Edge connectivity list (2 nodes per edge).
pxGetElementNodeIDs
Gets connectivity Node IDs of a given Element ID.
Input: Model name, part name, element id.
Output: Connectivity node id list.
List <size_t> pxGetElementNodeIDs(String sModel, String sPart, size_t iElementID)
return
Returns array of connectivity node ids if succeeds.
Returns empty array if failed.
sModel
Model name.
sPart
Part name which contains the Element ID.
Note: Part name will be identified if empty String is passed.
iElementID
Input element ID.
pxGetPartsAssociated
Gets a list of parts associated to a Node ID.
List<String> pxGetPartsAssociated(String sModel, int iNode)
return
Returns list of parts associated with the node if succeeds.
Returns empty array.
sModel
Model name.
iNode
Node ID.
xGetACAENode
Gets a CAE node from a part with a vertex index. User can get different Node IDs for different vertex index.
int xGetACAENode(String sModel, String sPart, int iVertexIndex)
return
Returns a CAE node if succeeds.
Returns -1 if failed.
sModel
Model name.
sPart
Model name.
iVertexIndex
Starts from 0 to number of triangle vertices. It fails for a wrong vertex index.
xHighlightID
Hightlights the node or element specified by ID and with the color specified by RGB values.
bool xHighlightID(String sModel, String sPart, size_t iID, float r, float, float b, bool bNodal)
return
Returns True if succeeds.
Returns False otherwise.
sModel
Name of the model, which contains node / element.
sPart
Name of the part, which contains node / element.
iID
Node or Elemental ID number.
r,g,b
RGB values in the range of (0,1) bNodal
True for Node and False for Element.
xClearHighlightID
Clears or removes the highlighting for the given node or element if it is highlighted already.
bool xClearHighlightID(String sModel, String sPart, unsigned int iID, bool bNodal)
return
Returns True if succeeds.
Returns False otherwise.
sModel
Name of the model, which contains node / element.
sPart
Name of the part, which contains node / element.
iID
Node or Elemental ID number.
bNodal
True for Node and False for Element.
pxIsCAENodeIDsExists
Checks if the node ids are available or not and returns the list of boolean flags corresponding to the list of given node IDs.
List<bool> pxIsCAENodeIDsExists(String sModel, String sPart, List <size_t> iNodeIDs,bool bUseVisibleParts)
return
Returns boolean flag for each nodes wrt to its index in iNodeIDs
sModel
Model name. If it is empty, it searches in current model.
sPart
Part name. If its empty, it searches in all models.
iNodeIDs
List of node ids to be validated for its existence.
bUseVisibleParts
If true, validates only in visible parts.
pxIsCAEElementIDsExists
Checks the element IDs if they are available or not and returns the array of boolean flags corresponding to the list of element IDs.
List<bool> pxIsCAEElementIDsExists(String sModel, String sPart,
List<size_t> iElementIDs, bool bUseVisibleParts)
return
Returns boolean flag for each nodes wrt to its index in iNodeIDs
sModel
Model name. If it is empty, it searches in current model.
sPart
Part name. If its empty, it searches in all models.
iElementIDs
List of element ids to be validated for its existence.
bUseVisibleParts
If true, validates only in visible parts.
pxGetFrameInfo
Gets all frame information of a model. It contains like file information and result attributes
List <String> pxGetFrameInfo(String sModel)
return
Returns the list of strings that is displayed in the current frame.
sModel
Model name. If it is empty, current model information will be returned.
pxGetFileInfoKeys
Gets all keys of file information of a model.
List <std::wstring> pxGetFileInfoKeys(String sModel)
return
Returns file information keys of a model in a list.
sModel
Model name. If it is empty, current model will be used.
xGetFileInfoAttribute
Gets assocted file info value for a give file info key.
String xGetFileInfoAttribute(String sModel,String sKey)
return
Returns value associated with the given key.
sModel
Model name. If it is empty, current model will be used.
sKey
File info key of a model.