CAE Hotspots

xSetCAEHotspotMode

Sets hotspot mode.

Local Extrema: Computes all the local minima/maxima for the whole field.

Global Extrema: Finds the number of maximum values and minimum values in the specified region.

In GUI

bool xSetCAEHotspotMode(const String sModel, bool bLocalExtrema)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bLocalExtrema

If True, sets LocalExrema else sets GlobalExtrema.

xGetCAEHotspotModeEx

Gets currently set hotspot mode.

int xGetCAEHotspotModeEx(const String sModel)

return

Returns hotspot mode.

0 - Global Extrema
1 - Local Extrema
2 - Range Cluster

sModel

Model name. Pass an empty string to apply in current model.

xSetCAEHotSpotsMinMax

Sets Hotspot finder range.

In GUI

bool xSetCAEHotSpotsMinMax(const String sModel, bool bEnableRangeMin, double fMinValue, bool bEnableRangeMax, double fMaxValue)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bEnableRangeMin

Sets minimum range.

fMinValue

Sets minimum range value.

bEnableRangeMax

Sets maximum range.

fMaxValue

Sets maximum range value.

pxGetCAEHotSpotsMinMax

Gets Min Max field assigned in Hotspot Finder dialog.

List<float> pxGetCAEHotSpotsMinMax(const StringsModel)

return

Returns array of size 4.

retArray[0] = bEnableRangeMin Gets set minimum range state.
retArray[1] = bEnableRangeMax Gets maximum range state
retArray[2] = fMinValue Gets minimum range value.
retArray[3] = fMaxValue Gets maximum range value.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xSetCAEHotSpotsCount

Sets required hotspots count.

In GUI

bool xSetCAEHotSpotsCount(const String sModel, bool bEnableTop, long iTopCount, bool bEnableBottom, long iBottomCount)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bEnableTop

If set True, finds top hotspots.

iTopCount

Sets the required top hotspots count.

bEnableBottom

If set True, find bottom hotspots.

iBottomCount

Sets the required bottom hotspots count.

pxGetCAEHotSpotsCount

List<int> pxGetCAEHotSpotsCount(const String sModel)

return

Returns array of size 4.

retArray[0] = bEnableTop    : If non zero, finding of top hotspots is enabled
retArray[1] = bEnableBottom : If non zero, finding is bottom hotspots is enabled
retArray[2] = iTopCount     : Gets required top hotspots count
retArray[3] = iBottomCount  : Gets required bottom hotspots count

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xSetCAEHotspotAllTopBottom

Sets flag to find all top hotspots and bottom hotspots.

In GUI

bool xSetCAEHotspotAllTopBottom(const String sModel, bool bEnableAllTop, bool bEnableAllBottom)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bEnableAllTop

Sets flag to find all top hotspots.

bEnableAllBottom

Sets flag to find all bottom hotspots.

pxGetCAEHotspotAllTopBottom

List<int> pxGetCAEHotspotAllTopBottom(const String sModel)

return

Returns array of size 2.

retArray[0] = bEnableAllTop     : State flag to find all top hotspots
retArray[1] = bEnableAllBottom  : State flag to find all bottom hotspots

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xSetCAEHotSpotsZoneRadius

Sets Zone radius info.

In GUI

bool xSetCAEHotSpotsZoneRadius(const String sModel, bool bEnableZoneRadius, float fZoneRadius)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bEnableZoneRadius

Sets Zone radius mode. If True, max/min hotspot in the zone is picked and other hotspots within this radius are ignored.

fZoneRadius

Sets Zone radius value.

pxGetCAEHotSpotsZoneRadius

List<float> pxGetCAEHotSpotsZoneRadius(const StringsModel)

return

Returns array of size 2.

retArray[0] = bSkipRadius : If non zero skip radius mode is enabled
retArray[1] = fSkipRadius : Radius value

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xSetCAEHotSpotsVisibleSurface

Sets to show ‘Visible Surface Labels’ only.

Visible Surface Labels: the labels of which, attached positions are visible in the current view.

In GUI

bool xSetCAEHotSpotsVisibleSurface(const String sModel, bool bVisibleSurface)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bVisibleSurface

If set to True, non visible surface labels are hidden.

xGetCAEHotSpotsVisibleSurfaceEx

bool xGetCAEHotSpotsVisibleSurfaceEx(const String sModel)

return

Returns bVisibleSurface state. If set to True, Non visible surface labels are hidden

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xSetCAEHotspotViewpointOptions

Sets viewpoint options for hotspots to be generated.

In GUI

bool xSetCAEHotspotViewpointOptions(const String sModel, bool bEachParts, bool bAllStdViews, bool bHotspotPerPage, long iHotspotPerPage, bool bEnableRegions, short iHorizontalRegions, short iVerticalRegions)

return

Returns True if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bEachParts

If True, Applies hotspot finder settings to each individual parts.

If False, settings are applied to the current scene.

bAllStdViews

Adds views from all axes directions. Like X, -X, Y, -Y, Z, -Z, etc.

bHotspotPerPage

Sets number of labels per viewpoint filter.

iHotspotPerPage

Sets number of labels per page.

If actual hotspots are more than the set number, new viewpoints will be created for each set of labels.

New pages are sorted based on top/bottom values.

bEnableRegions

Sets regional focus on the model.

iHorizontalRegions

Sets horizontal regions.

iVerticalRegions

Sets vertical regions.

xSetCAEHotspotViewpointOptionsEx1

Sets the visibility of info label when hot spot viewpoints are generated.

bool xSetCAEHotspotViewpointOptionsEx1(bool bInfoLabel, float fInfoLabelX, float fInfoLabelY, bool bReleative)

return

Returns True, if successful.

bInfoLabel

Set True to show the info label.

fInfoLabelX, fInfoLabelY

Info label X, Y position in screen space.

bReleative

Set True to use fInfoLabelX, fInfoLabelY as the relative position to screen size.

Otherwise, X, Y values are used as the exact pixel position in screen space.

xSetCAEHotspotViewpointOptionsAuto

Sets auto viewpoint generation flag for hotspots viewpoint creation.

In GUI

bool xSetCAEHotspotViewpointOptionsAuto(const String sModel, bool bAutoViewPoint, short iAutoviewCount)

return

Returns True, if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

bAutoViewPoint

Set True to enable auto viewpoint creation.

iAutoviewCount

Sets the required number of auto viewpoints.

xCAEHotspotsViewPointOptionsAddView

Adds current camera position as a view in hotspots viewpoint options.

bool xCAEHotspotsViewPointOptionsAddView(String sModel)

return

Returns True, if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xCAEHotspotsViewPointOptionsAddViewEx

bool xCAEHotspotsViewPointOptionsAddViewEx(String sModel, String sView)

sModel

Model name.

sView

Viewpoint name.

xCAEHotspotsViewPointOptionsClear

Deletes all viewpoints in hotspot viewpoint options table.

bool xCAEHotspotsViewPointOptionsClear(String sModel)

return

Returns True, if successful.

sModel

Reserved for future use. Can be ignored now by passing an empty String.

xCAEFindHotspots

Generates the hotspot labels for the given settings.

bool xCAEFindHotspots(bool bAddViewPath, const String sViewPath)

return

Returns True if successful.

bAddViewPath

If True, created hotspots will be stored in a view path.

If False, only hotspot labels are generated, no viewpoints will be generated.

sViewPath

Viewpath name.

xCAEFindHotspotsEx

Finds hotspot extended method.

bool xCAEFindHotspotsEx(bool bAddViewPoint, const String sViewPath, const String sViewPtPrefix)

bAddViewPath

Set True to add viewpoints for the found hotspots with given settings.

sViewPath

Name of the view path for the generated viewpoints.

sViewPtPrefix

Prefix text for the generated viewpoints.

xSetCAEHotSpotsMarkMinMax

Sets MarkMinMax state for a model.

bool xSetCAEHotSpotsMarkMinMax(String sModel, bool bMarkMinMax)

return

Returns True, if successful.

sModel

Model Name.

bMarkMinMax

Set True to highlight minimum-maximum occurred probe labels.

xGetCAEHotSpotsMarkMinMax

Gets applied state for MarkMinMax of a model.

bool xGetCAEHotSpotsMarkMinMax(String sModel)

return

Returns True, if successful.

sModel

Model name.

pxGetCAEHotspotViewpointOptionsEx1

Gets applied info for hotspot viewpoint info label.

List<float> pxGetCAEHotspotViewpointOptionsEx1()

return

Returns array of size 4.

retArray[0] = bInfoLabel  : Visibility flag for info label
retArray[1] = fInfoLabelX : X location of info label
retArray[2] = fInfoLabelY : Y location of info label
retArray[3] = bReleative  : Flag for the relative position or absolute

xIsCAEMinMaxRangeMarked

Checks probe table is highlighted or not, based on applied constraints.

int xIsCAEMinMaxRangeMarked()

return

Returns 1 if any of one probe tables in the current frame is highlighted based on constraint applied in hotspot result dialog min-max range.

Returns 0 when no probe table in the current frame is highlighted.

xIsCAEHeaderLegendVisible

Gets Header Legend’s visibility.

bool xIsCAEHeaderLegendVisible(String sModel)

return

Returns True, if successful.

sModel

CAE Model Name.

xIsCAEMinMaxRangeMarkedEx

int xIsCAEMinMaxRangeMarkedEx(String sModel)

return

…

sModel

CAE Model Name.

xSetCAEHotspotViewpointOptionsInfoLabel

Enables and positions the label that displays viewpoint info.

bool xSetCAEHotspotViewpointOptionsInfoLabel(bool bInfoLabel, float fInfoLabelX, float fInfoLabelY)

return

Returns True, if successful.

bInfoLabel

Set True to display label.

fInfoLabelX, fInfoLabelY

Screen X, Y position.

xCAEFindHotspotsRect

Finds hotspot in the screen rectangular region defined by given relative positions and hotspot mode.

bool xCAEFindHotspotsRect(float xRef, float yRef, float width, float height, int iHotspotMode, bool bVisibleSurface)

return

Returns True if succeed.

Returns False if failed.

xRef, yRef

Normalized screen position of the user-defined rectangular region. (Values 0 to 1).

width, height

Normalized screen width and height of the user-defined rectangular region. (Values 0 to 1).

iHotspotMode

0 – hotspots according to hotspot setting dialog parameters (top, bottom, zone radius, etc)
1 – finds minimum value in the region for current scalar result in Global extrema method
2 – finds the maximum value in the region for current scalar result in Global extrema method

bVisibleSurface

True – finds hotspots only on visible surface elements.

False – considers all elements within the region.

xCAEFindHotspotsBox

Finds hotspots in a provided box region.

bool xCAEFindHotspotsBox(String sModel, float xPos, float yPos, float zPos, float dx, float dy, float dz, int iHotspotMode, bool bVisibleSurface)

return

Returns True, if successful.

sModel

Model name.

xPos, yPos, zPos

Bounding box center in world coordinate system.

dx, dy, dz

Delta X, delta Y, delta Z from center to make bounding box.

iHotspotMode

0 – Hotspots according to hotspot setting dialog parameters (top, bottom, zone radius, etc)
1 – Finds minimum value in the region for current scalar result in Global extrema method
2 – Finds the maximum value in the region for current scalar result in Global extrema method

bVisibleSurface

True – Finds hotspots only on visible surface elements.

False – Considers all elements within the region.

xCAEFindHotspotsSphere

Finds hotspots within a spherical region.

bool xCAEFindHotspotsSphere(String sModel, float xPos, float yPos, float zPos, float fRadius, int iHotspotMode, bool bVisibleSurface)

return

Returns True, If successful.

sModel

Model name.

xPos, yPos, zPos

Spherical center in world coordinates.

fRadius

Sphere radius.

iHotspotMode

0 – Hotspots according to hotspot setting dialog parameters (top, bottom, zone radius, etc)
1 – Finds minimum value in the region for current scalar result in Global extrema method
2 – Finds the maximum value in the region for current scalar result in Global extrema method

bVisibleSurface

True – Finds hotspots only on visible surface elements.

False – Considers all elements within the region.

xCAEFindHotspotVisibleNodes

Mask invisible nodes(visible surface) and compute hotspots.

bool xCAEFindHotspotVisibleNodes(String sModel)

return

Returns True, if successful.

sModel

Model name.

xSetCAEHotspotModeEx

Sets Hotspot type for Hotspot Finder settings.

bool xSetCAEHotspotModeEx(String sModel, int iHotspotMode)

return

Returns True, if successful.

sModel

Model name.

iHotspotMode

Hotspot Type. Valid Range 0-2.

0 - Local Extrema
1 - Global Extrema
2 - Range Cluster