Applying Highlight (Silhouette) with Scenegraph

The Highlight functionality draws a colored contour around a geometry.

Supported platforms

• Supported in both Windows and Portable platforms.

• Supported by Mwx, RFC, MwxSoup, SGL, and POPMesh. Not supported by SPC.

Setting highlight

User can manage highlighting through the following fields.

Parameters

Both highlightIDs and setHighlightForID fields require the following parameters:

• Key - Set this value to the geometry unique ID. The ID could be, for example, retrieved from a PickSensor.

• Value - Contains the parameters to customize the silhouette. The parameters are separated by a pipe (|).

• Color - SVEC3 (RGB) or SVEC4 (RGBA) color value in (0-1) scale.

• Skip Z Test - SBOOL type. When set to true, the silhouette displays over everything. The default is false. This value is optional. SGL will ignore this parameter (it does not support the skip of Z Test).

Examples

These are examples of valid key and values.

• RGBA color with Skip Z Test example: scene02|jersey_001=1 0 0 0.5|true

• RGB color with no Skip Z Test example: scene02|jersey_001=1 0 0|false

• RGB color with no Skip Z Test example: scene02|jersey_001=1 0 0

Note: With Mwx based content, it is possible to assign different Skip Z test values for each element in the dictionary to mix the behaviors. With MwxSoup, RFC, and POPMesh, it's not possible because the same Skip Z test value is applied to all geometries in the same node. Therefore, you need to assign in the dictionary the same Skip Z test value to all geometries belonging to the same node to avoid unexpected behaviors. This also applies to lastly added geometry setting commands.

Resetting highlight

When removing an entry from highlightIDs, its highlight value is automatically reset.

To reset highlight for a single scene element, use resetHighlightForID and pass it the scene element uniqueID.

To reset a whole file, use resetHighlightForAllID and pass it the file node name or a file scene element uniqueID.