void PutFile(_bstr_ _arg1);

Creates the right tool based on the configuration file extension. This is probably the single most important method. You can create an application using only this method.

VIZCODE GetVizType();

Returns an enum indicating the type of visualization tool. It returns VIZ_UNKNOWN if no configuration file has been opened yet. Other values are: VIZ_MAP, VIZ_SCATTER, VIZ_SPLAT, VIZ_EVI, VIZ_DTABLE, and

VIZ_TREE (in the VizCommon.idl file this is the VizType property).

HRESULT SetScale(float s);

In the Tree Visualizer, Evidence Visualizer, Decision Table Visualizer, and Map Visualizer, this function scales the heights of objects in the scene. In the Scatter Visualizer, it scales the size of the entities. In the Splat Visualizer it scales the opacity. For the MineSet Visualizer application the scale is adjusted by the slider on the left trim of the viewer.

HRESULT ShowDecoration(long on);

Turns on or off (TRUE/FALSE) the Inventor window decoration based on the value of on.

HRESULT ShowBackgroundColorDialog();

Brings up the color selector dialog, so the user can select a desired background color.

HRESULT SetBackgroundColor(float r,
float g,
float b);

Explicitly sets a specific background color.

HRESULT ShowFilterDialog();

Brings up a filter panel of some type that can be used to reduce the amount of geometry in the scene. The Scatter Visualizer, Splat Visualizer, Decision Table Visualizer, and Map Visualizer use the same style of filter dialog. The Tree Visualizer and Evidence Visualizer have their own variations.

HRESULT DoIdle(long lCount);

Makes Inventor run smoothly. It should be called in your application's OnIdle member function.

For example:

BOOL CVizApp::OnIdle(LONG lCount) { if (m_bIsProcessing) { m_pVizView->m_vizCompositeCtrl.Idle(lCount) ; } return CWinApp::OnIdle(lCount);}m_bIsProcessing must be set to true in the view's OnInitialUpdate:

((CVizApp *)AfxGetApp())->m_bIsProcessing = TRUE;

HRESULT ShowSelectionDialog();

Brings up a table showing information about all the objects in the scene which are currently selected. For the visualization application supplied with MineSet, this method is called when the user selects Show Values from the Selection menu.

HRESULT SetLegendHeight(short numLegends);

Sets the height of the legend control at the bottom of the visualization tool. If the numLegends argument is 3, then the height of the legend control will be enough to show three legends without the help of a vertical scrollbar.

HRESULT EnableSound(long on);

Turns the sound effects on or off (TRUE or FALSE respectively.)

VIEWINGCODE GetViewingMode();

Returns the Inventor viewing mode, either VIEWING_PICK (viewer turned on) or VIEWING_GRASP (viewer turned off). When the viewer is turned on (pick mode), events are consumed by the viewer. When viewing is off, events are processed by the viewer's render area. This means events will be sent to the scene graph for processing (that is, picking can occur). These methods have no meaning for Tree Visualizer, which does not use a model viewer.

void PutViewingMode(VIEWINGCODE pVal);

Establishes the desired viewing mode (either VIEWING_PICK or VIEWING_GRASP). In grasp mode, the cursor appears as a hand, and viewing transformations are performed. In pick mode, no navigation is possible, but you can pick and select objects in the scene. These methods have no meaning for Tree Visualizer, which does not use a model viewer.

long GetSupportsAnimation();

Returns TRUE if the visualization tool currently instantiated supports animation. In other words, returns TRUE if sliders are present. Some tools such as the Evidence Visualizer, Decision Table Visualizer, and Tree Visualizer never have animation in their current implementations. For these visualizers GetSupportsAnimation always return FALSE.

_bstr_t GetSelectionExpression();

Returns the selection expression which has been created based on the current selection of objects in the scene. This string is typically used to drill through to the underlying data in some manner, but there are other potential uses. If nothing has been selected the expression is an empty string (“”).

_bstr_t GetHistoryString();

Returns the history from the configuration file. This history contains everything that the Tool Manager needs to recreate its state at the time the current visualization was created.

_bstr_t GetTitleString();

Returns an appropriate application title including the application name and current configuration file base name.

HRESULT EnableStereo(long on);

Turns on stereo rendering in the 3D viewer. It may be necessary to set hardware specific settings, and/or have certain peripherals like Crystal Eyes glasses before stereo is actually useful.

HRESULT SetStereoOffset(float offset);

Sets the amount of eye separation for the left and right stereo views.

HRESULT SetSelectionsHeight(short height);

Sets the height (in pixels) of the selection control which appears at the top of all tools and displays pick information.

HRESULT EnableWarnOnExecute(long on);

Specifies whether the user should be warned when a user-defined execute statement is invoked (this occurs when an object is double clicked and such an execute statement has been defined). The warning might be useful if you are concerned about security.

HRESULT EnableQuiet(long on);

Turns off the display of all error and warning popup messages. In most cases this option should be off (FALSE). See also SetErrorFile.

HRESULT SetErrorFile(_bstr_t fileName);

Specifies a file where all error messages should be sent. If an error file is set, error messages will still appear in dialogs on the screen. If you do not want the dialogs to appear on the screen you should use EnableQuiet(TRUE). This method is primarily used for debugging and testing of applications made using the composite control.

HRESULT SetHideDistance(float distance);

Sets the distance at which level of detail is hidden. The most common use of this distance factor is in changing the level of detail on 3D text displayed in a scene. This option could also change detail thresholds in other circumstances. Sometimes the text has three or four levels of detail (hidden, bounding box, wire frame, full 3D), the distance parameter sets the first threshold, and the other thresholds are scalar multiples.

void PutNullStyle(DRAW_STYLE style);

Allows you to set how Null Values are displayed in the scene. Possible values are SOLID, HIDDEN and OUTLINE. Outline behaves the same as hidden for all tools except the Tree Visualizer.

DRAW_STYLE GetNullStyle();

Returns current setting for how Null values are displayed.

HRESULT SetFont(_bstr_t fontName);

Sets a desired font. This might be particularly useful for certain locales.

HRESULT SaveSceneGraph(_bstr_t fileName);

Outputs the current scenegraph to a file in Inventor format. This .iv file cannot be loaded directly into another application, however, without having the right DLL's installed. This method is primarily used for debugging and testing.

HRESULT SaveCompositeImage(_bstr_t fileName,
long hWnd);

Outputs the current scenegraph to a file in Inventor format. This saves an image of the whole composite control to a file. An offscreen renderer is not used to save the scene, so if you want improved resolution, a better choice might be SaveViewerImage.

HRESULT SaveViewerImage(_bstr_t fileName,
float desiredXinches,
float desiredYinches,
short printerDPI);

Saves the main viewer image to a file. An offscreen renderer is used for this, so the resolution is better. If the last three arguments are not specified (or are 0), then values are chosen based on the current screen size and resolution.

HRESULT HasLegend(long *HasLegend);

Returns TRUE or FALSE depending on whether or not a legend is present at the bottom.

HRESULT SaveLegendImage(_bstr_t fileName);

Takes a snapshot of the legend control and saves it to a file. This method is primarily used for debugging and testing.

HRESULT SaveDataTable(_bstr_t fileName);

Stores the tools internal data table to a file. This method is primarily used for debugging and testing.

HRESULT PrintCompositeImage(long hDC,
long hWnd;

Prints an image of the window pointed to by hWnd to a file. An offscreen rendered is not used for saving the scene, so SaveViewerImage might be better for improved resolution. If hWnd is NULL, only the main rendering window image is saved.

HRESULT SetMouseButtonStyle(MBUTTON_STYLR
 style);

Selects the desired mouse mapping mode. Possible values are, MINESET_TWO_BUTTON_STYLE and MINESET_THREE_BUTTON_STYLE

Since many users do not have a three-button mouse, MineSet now allows for two-button operation. For those familiar with previous versions of MineSet on the IRIX platform, three-button style offers the same controls as before. The default, two-button style, is more consistent between tools and has less dependence on the use of modifier keys. However, no functionality is lost with either a three- or a two-button mouse. See the Navigation entry in the MineSet Enterprise Edition Reference Guide for mouse button navigation details.

HRESULT SetCameraPosition(float x,
float y,
float z);

HRESULT GetCameraPosition(float *v);

Provides methods of manipulating the camera viewpoint. Normally, the user interacts with the scene using the mouse, but an application may require alternative methods for setting or getting the viewpoint and orientation. Possible uses are setting up or running animations, saving or restoring interesting viewpoints, alternative input devices, and so forth.

HRESULT SetCameraOrientation(float x,
float y,
float z,
float angle);

HRESULT GetCameraOrientation(float *v);

Changes camera orientation. In SetCameraOrientation, x, y, z are the components of the axis, and angle is the rotation of the camera around that axis of orientation in radians.

In GetCameraOrientation, x, y, and z are the components of the axis orientation, angle gives the orientation of the camera about that axis in radians.

void SetFile(LPCTSTR fileName);

Creates the right tool based on the configuration file extension. This is probably the single most important method. You can create an application using only this method.

long GetVizType();

Returns an enum indicating the type of visualization tool. It returns VIZ_UNKNOWN if no configuration file has been opened yet. Other values are: VIZ_MAP, VIZ_SCATTER, VIZ_SPLAT, VIZ_EVI, VIZ_DTABLE, and

VIZ_TREE (in the VizCommon.idl file this is the VizType property).

void SetScale(float s);

In the Tree Visualizer, Evidence Visualizer, Decision Table Visualizer, and Map Visualizer, this function scales the heights of objects in the scene. In the Scatter Visualizer, it scales the size of the entities. In the Splat Visualizer it scales the opacity. For the MineSet Visualizer application the scale is adjusted by the slider on the left trim of the viewer.

void ShowDecoration(long on);

Turns on or off (TRUE/FALSE) the Inventor window decoration based on the value of on.

void ShowBackgroundColorDialog();

Brings up the color selector dialog, so the user can select a desired background color.

void SetBackgroundColor(float r,
float g,
float b);

Explicitly sets a specific background color.

void ShowFilterDialog();

Brings up a filter panel of some type that can be used to reduce the amount of geometry in the scene. The Scatter Visualizer, Splat Visualizer, Decision Table Visualizer, and Map Visualizer use the same style of filter dialog. The Tree Visualizer and Evidence Visualizer have their own variations.

void DoIdle(long lCount);

Makes Inventor run smoothly. It should be called in your application's OnIdle member function.

For example:

BOOL CVizApp::OnIdle(LONG lCount) { if (m_bIsProcessing) { m_pVizView->m_vizCompositeCtrl.Idle(lCount) ; } return CWinApp::OnIdle(lCount);}m_bIsProcessing must be set to true in the view's OnInitialUpdate:

((CVizApp *)AfxGetApp())->m_bIsProcessing = TRUE;

void ShowSelectionDialog();

Brings up a table showing information about all the objects in the scene which are currently selected. For the visualization application supplied with MineSet, this method is called when the user selects Show Values from the Selection menu.

void SetLegendHeight(short numLegends);

Sets the height of the legend control at the bottom of the visualization tool. If the numLegends argument is 3, then the height of the legend control will be enough to show three legends without the help of a vertical scrollbar.

void EnableSound(long on);

Turns the sound effects on or off (TRUE or FALSE respectively.)

long GetViewingMode();

Returns the Inventor viewing mode, either VIEWING_PICK (viewer turned on) or VIEWING_GRASP (viewer turned off). When the viewer is turned on (pick mode), events are consumed by the viewer. When viewing is off, events are processed by the viewer's render area. This means events will be sent to the scene graph for processing (that is, picking can occur). These methods have no meaning for Tree Visualizer, which does not use a model viewer.

void SetViewingMode(long nNewValue);

Establishes the desired viewing mode (either VIEWING_PICK or VIEWING_GRASP). In grasp mode, the cursor appears as a hand, and viewing transformations are performed. In pick mode, no navigation is possible, but you can pick and select objects in the scene. These methods have no meaning for Tree Visualizer, which does not use a model viewer.

Long GetSupportsAnimation();

Returns TRUE if the visualization tool currently instantiated supports animation. In other words, returns TRUE if sliders are present. Some tools such as the Evidence Visualizer, Decision Table Visualizer, and Tree Visualizer never have animation in their current implementations. For these visualizers GetSupportsAnimation always return FALSE.

CString GetSelectionExpression();

Returns the selection expression which has been created based on the current selection of objects in the scene. This string is typically used to drill through to the underlying data in some manner, but there are other potential uses. If nothing has been selected the expression is an empty string (“”).

CString GetHistoryString();

Returns the history from the configuration file. This history contains everything that the Tool Manager needs to recreate its state at the time the current visualization was created.

CString GetTitleString();

Returns an appropriate application title including the application name and current configuration file base name.

void EnableStereo(long on);

Turns on stereo rendering in the 3D viewer. It may be necessary to set hardware specific settings, and/or have certain peripherals like Crystal Eyes glasses before stereo is actually useful.

void SetStereoOffset(float offset);

Sets the amount of eye separation for the left and right stereo views.

void SetSelectionsHeight(short height);

Sets the height (in pixels) of the selection control which appears at the top of all tools and displays pick information.

void EnableWarnOnExecute(long on);

Specifies whether the user should be warned when a user-defined execute statement is invoked (this occurs when an object is double clicked and such an execute statement has been defined). The warning might be useful if you are concerned about security.

void EnableQuiet(long on);

Turns off the display of all error and warning popup messages. In most cases this option should be off (FALSE). See also SetErrorFile.

void SetErrorFile(LPCTSTR fileName);

Specifies a file where all error messages should be sent. If an error file is set, error messages will still appear in dialogs on the screen. If you do not want the dialogs to appear on the screen you should use EnableQuiet(TRUE). This method is primarily used for debugging and testing of applications made using the composite control.

void SetHideDistance(float distance);

Sets the distance at which level of detail is hidden. The most common use of this distance factor is in changing the level of detail on 3D text displayed in a scene. This option could also change detail thresholds in other circumstances. Sometimes the text has three or four levels of detail (hidden, bounding box, wire frame, full 3D), the distance parameter sets the first threshold, and the other thresholds are scalar multiples.

void PutNullStyle(long nNewValue);

Allows you to set how Null Values are displayed in the scene. Possible values are SOLID, HIDDEN and OUTLINE. Outline behaves the same as hidden for all tools except the Tree Visualizer.

long GetNullStyle();

Returns current setting for how Null values are displayed.

void SetFont(LPCTSTR fontName);

Sets a desired font. This might be particularly useful for certain locales.

void SaveSceneGraph(LPCTSTR fileName);

Outputs the current scenegraph to a file in Inventor format. This .iv file cannot be loaded directly into another application, however, without having the right DLL's installed. This method is primarily used for debugging and testing.

void SaveCompositeImage(LPCTSTR fileName,
long hWnd);

Outputs the current scenegraph to a file in Inventor format. This saves an image of the whole composite control to a file. An offscreen renderer is not used to save the scene, so if you want improved resolution, a better choice might be SaveViewerImage.

void SaveViewerImage(LPCSTR fileName,
float desiredXinches,
float desiredYinches,
short printerDPI0);

Saves the main viewer image to a file. An offscreen renderer is used for this, so the resolution is better. If the last three arguments are not specified (or are 0), then values are chosen based on the current screen size and resolution.

void HasLegend(long *HasLegend);

Returns TRUE or FALSE depending on whether or not a legend is present at the bottom.

void SaveLegendImage(LPCTSTR fileName);

Takes a snapshot of the legend control and saves it to a file. This method is primarily used for debugging and testing.

void SaveDataTable(LPCTSTR fileName);

Stores the tools internal data table to a file. This method is primarily used for debugging and testing.

void PrintCompositeImage(long hDC,
long hWnd;

Prints an image of the window pointed to by hWnd to a file. An offscreen rendered is not used for saving the scene, so SaveViewerImage might be better for improved resolution. If hWnd is NULL, only the main rendering window image is saved.

void SetMouseButtonStyle(long style);

Selects the desired mouse mapping mode. Possible values are, MINESET_TWO_BUTTON_STYLE and MINESET_THREE_BUTTON_STYLE

Since many users do not have a three-button mouse, MineSet now allows for two-button operation. For those familiar with previous versions of MineSet on the IRIX platform, three-button style offers the same controls as before. The default, two-button style, is more consistent between tools and has less dependence on the use of modifier keys. However, no functionality is lost with either a three- or a two-button mouse. See the Navigation entry in the MineSet Enterprise Edition Reference Guide for mouse button navigation details.

void SetCameraPosition(float x,
float y,
float z);

void GetCameraPosition(float *v);

Provides methods of manipulating the camera viewpoint. Normally, the user interacts with the scene using the mouse, but an application may require alternative methods for setting or getting the viewpoint and orientation. Possible uses are setting up or running animations, saving or restoring interesting viewpoints, alternative input devices, and so forth.

void SetCameraOrientation(float x,
float y,
float z,
float angle);

void GetCameraOrientation(float *v);

Changes camera orientation. In SetCameraOrientation, x, y, z are the components of the axis, and angle is the rotation of the camera around that axis of orientation in radians.

In GetCameraOrientation, x, y, and z are the components of the axis orientation, angle gives the orientation of the camera about that axis in radians.

HRESULT SetSelectionExpression(_bstr_t selectionExp);

Changes the set of currently selected objects in the scene.

_bstr_t GetFilterExpression();

Returns the filter expression.

HRESULT SetFilterExpression(_bstr_t filterExp);

Specifies the filter expression and filters the scene objects appropriately.

HRESULT EnableDynamicBrushing(long on);

Specifies whether selection events should be propagated between multiple visualization windows. If turned on, the selection expression of an object selected in one window is propagated to all other visualization window, and the corresponding objects are highlighted.

HRESULT PublishOnWeb(_bstr_t fileName);

Compresses visualization, data, and schema files into a single MTR archive for publishing on the web.

HRESULT GenerateReport(_bstr_t fileName);

Generates a HTML based report for the current visualization.

HRESULT ShowDrillThroughDialog();

Brings up a dialog which allows the user to set options for drill through and then invoke it. Uses the method SendDrillThroughRequest of ISyncServer to process the drill through request (that is, communication with Tool Manager). Alternatively, the plugin viz tool may wish to do its own drill through handling. It is up to the plugin viz tool to implement the drill through dialog and interprocess communication. VizMain implements a default that can be used in conjunction with Tool Manager.

void SetSelectionExpression(LPCTSTR selectionExp);

Changes the set of currently selected objects in the scene.

CString GetFilterExpression();

Returns the filter expression.

void SetFilterExpression(LPCTSTR filterExp);

Specifies the filter expression and filters the scene objects appropriately.

void EnableDynamicBrushing(long on);

Specifies whether selection events should be propagated between multiple visualization windows. If turned on, the selection expression of an object selected in one window is propagated to all other visualization window, and the corresponding objects are highlighted.

void PublishOnWeb(LPCSTR fileName);

Compresses visualization, data, and schema files into a single MTR archive for publishing on the web.

void GenerateReport(LPCSTR fileName);

Generates a HTML based report for the current visualization.

void ShowDrillThroughDialog();

Brings up a dialog which allows the user to set options for drill through and then invoke it. Uses the method SendDrillThroughRequest of ISyncServer to process the drill through request (that is, communication with Tool Manager). Alternatively, the plugin viz tool may wish to do its own drill through handling. It is up to the plugin viz tool to implement the drill through dialog and interprocess communication. VizMain implements a default that can be used in conjunction with Tool Manager.

HRESULT ShowDrillThroughColumnDialog();

Brings up a dialog that allows you to select which columns you want to be significant on drill through. In other words you use the dialog to specify which columns could potentially be in the selection Expression (see GetSelectionExpression on page 170).

HRESULT SetTrailType(TRAILCODE trailtype);

Specifies what type of trails to use if any. Possible values of TRAILCODE are NO_TRAILS, LINE_TRAILS, FADE_OUT_TRAILS, and TUBE_TRAILS.

HRESULT ShowAnimationPanel(long on);

Indicates that if the argument is TRUE show the animation panel, otherwise hide it. If there is no animation panel, it cannot be shown.

HRESULT CreateBoxSelection();

Creates a bounding box which can be used to select entities.

HRESULT UseSliderOnDrillThough(long on();

Specifies whether or not the animation slider position should be used in constructing the drill through expression when you drill through.

HRESULT Set2DSliderPositions(float slider1Pos,
float slider2Pos);

Allows you to programmatically alter the slider position. If the slider is one dimensional then the second argument is ignored.

void PutShape(SHAPECODE pVal);

Refers to the current entity shape type. Possible values for the Scatter Visualizer are: SHAPE_CUBE SHAPE_SPHERE SHAPE_DIAMOND SHAPE_BAR

SHAPECODE GetShape();

Returns the current shape type.

HRESULT EnableSpinAnimation(long on);

Specifies whether or not the automatic spin animation should be enabled in the viewer. If on is set to TRUE, then it is possible to set the animation continuously spinning by doing a rotation and releasing the left mouse before you are done dragging.

HRESULT SetLabelSize(float size);

Sets the scale size of object labels that appear in the scene. The larger the value of size the bigger the label.

HRESULT SetAxisLabelSize(float size);

Sets the scale size of axis labels that appear in the scene. This applies to the labels at the ends of the axes in Scatter and Splat Visualizers.

HRESULT SetGridColor(float r, float g, float b);

Sets the color for the grid.

HRESULT SetGridSize(float axis1,
float axis2,
float axis3);

Sets the grid spacing in each of the 3 dimensions. Larger values indicate wider grid line spacing. A value of 0 means do not draw any grid lines in that axis dimension. If the value of all axes is 0, then no grid is drawn.

HRESULT SetOrientation(ORIENTATIONCODE orientation);

Specifies which of the three available orthogonal orientations the view should be set to. Possible values are: ORIENTATION_FRONT ORIENTATION_RIGHT ORIENTATION_TOP ORIENTATION_DEFAULT ORIENTATION_DEFAULT allows the viz tool to choose the orientation.

HRESULT EnablePerspective(long on);

Sets whether or not to use perspective in the 3D viewer. If TRUE then use perspective projection if FALSE then use orthogonal projection.

HRESULT SaveAnimationPaneImage(_bstr_t filename);

Takes a snapshot of the animation control and saves it to a file. This method is primarily used for debugging and testing.

void ShowDrillThroughColumnDialog();

Brings up a dialog that allows you to select which columns you want to be significant on drill through. In other words you use the dialog to specify which columns could potentially be in the selection Expression (see GetSelectionExpression on page 170).

void SetTrailType(long trailtype);

Specifies what type of trails to use if any. Possible values of TRAILCODE are NO_TRAILS, LINE_TRAILS, FADE_OUT_TRAILS, and TUBE_TRAILS.

void ShowAnimationPane(long on);

Indicates that if the argument is TRUE show the animation panel, otherwise hide it. If there is no animation panel, it cannot be shown.

void CreateBoxSelection();

Creates a bounding box which can be used to select entities.

void UseSliderOnDrillThough(long on();

Specifies whether or not the animation slider position should be used in constructing the drill through expression when you drill through.

void Set2DSliderPositions(float slider1Pos,
float slider2Pos);

Allows you to programmatically alter the slider position. If the slider is one dimensional then the second argument is ignored.

void SetShape(long nNewValue);

Refers to the current entity shape type. Possible values for the Scatter Visualizer are: SHAPE_CUBE SHAPE_SPHERE SHAPE_DIAMOND SHAPE_BAR

void GetShape();

Returns the current shape type.

void EnableSpinAnimation(long on);

Specifies whether or not the automatic spin animation should be enabled in the viewer. If on is set to TRUE, then it is possible to set the animation continuously spinning by doing a rotation and releasing the left mouse before you are done dragging.

void SetLabelSize(float size);

Sets the scale size of object labels that appear in the scene. The larger the value of size the bigger the label.

void SetAxisLabelSize(float size);

Sets the scale size of axis labels that appear in the scene. This applies to the labels at the ends of the axes in Scatter and Splat Visualizers.

void SetGridColor(float r, float g, float b);

Sets the color for the grid.

void SetGridSize(float axis1,
 float axis2,
float axis3);

Sets the grid spacing in each of the 3 dimensions. Larger values indicate wider grid line spacing. A value of 0 means do not draw any grid lines in that axis dimension. If the value of all axes is 0, then no grid is drawn.

void SetOrientation (long orientation);

Specifies which of the three available orthogonal orientations the view should be set to. Possible values are: ORIENTATION_FRONT ORIENTATION_RIGHT ORIENTATION_TOP ORIENTATION_DEFAULT ORIENTATION_DEFAULT allows the viz tool to choose the orientation.

void EnablePerspective(long on);

Sets whether or not to use perspective in the 3D viewer. If TRUE then use perspective projection if FALSE then use orthogonal projection.

void SaveAnimationPaneImage(LPCTSTR filename);

Takes a snapshot of the animation control and saves it to a file. This method is primarily used for debugging and testing.

HRESULT EnableShadows(long on);

Specifies whether to use projective shadow rendering.

HRESULT SetShadowColor(float r,
float g,
float b);

Specifies the overall color for shadows.

void ShowPickDragger(long on);

Specifies whether the Splat Visualizer pick-dragger is shown, otherwise it is hidden (on=TRUE—shown, on=FALSE—hidden).

long GetShowingPickDragger();

Returns TRUE if the pick dragger is currently showing.

HRESULT ShowAnimationPanel(long on);

Specifies whether the animation panel is shown (on=TRUE—shown, on=FALSE—hidden). If there is no animation panel, it cannot be shown.

HRESULT CreateBoxSelection();

Creates a bounding box which can be used to select splats.

HRESULT UseSliderOnDrillThrough(long on);

Specifies whether the animation slider position should be used in constructing the drill through expression.

HRESULT Set2DSliderPositions(float slider1Pos,
float slider2Pos);

Allows you to programmatically alter the slider position. If the slider is one dimensional then the second argument is ignored.

void PutShape(SHAPECODE pVal);

Sets the shape type for splats: SHAPE_CUBE, SHAPE_SPHERE, SHAPE_DIAMOND, SHAPE_BAR, SHAPE_LINEAR, SHAPE_GAUSSIAN, or SHAPE_TEXTURE

SHAPECODE GetShape();

Returns the current shape type.

HRESULT EnableSpinAnimation(long on);

Specifies whether the automatic spin animation should be enabled in the viewer. If on is set to TRUE, then it is possible to set the animation continuously spinning by doing a rotation and releasing the left mouse before you are done dragging.

HRESULT SetAxisLabelSize(float size);

Sets the scale size of axis labels that appear in the scene. This applies to the labels at the ends of the axes in Scatter Visualizer and Splat Visualizer and similar tools.

HRESULT SetGridColor(float r, float g, float b);

Sets the color for the grid.

HRESULT SetGridSize(float axis1,
 float axis2,
 float axis3);

Sets the grid spacing in each of the three dimensions. Larger values indicate wider grid line spacing. A value of 0 means do not draw any grid lines in that axis dimension. If the value of all axes is 0, then no grid is drawn.

HRESULT SetOrientation(ORIENTATIONCODE orientation);

Specifies to which of three orthogonal orientations the view should be set Possible values are ORIENTATION_FRONT, ORIENTATION_RIGHT, ORIENTATION_TOP, and ORIENTATION_DEFAULT, where ORIENTATION_DEFAULT uses the orientation that the visualization tool thinks best.

HRESULT EnablePerspective(long on);

Sets whether to use perspective in the 3D viewer. If TRUE use perspective projection, if FALSE use orthogonal projection.

HRESULT SaveAnimationPaneImage(_bstr_t fileName);

Takes a snapshot of the animation control and saves it to a file. This method is primarily used for debugging and testing.

HRESULT GetUsingNominalSplats();

Returns TRUE if a string valued attribute is mapped to color. In this case the splats will show a distribution of colors corresponding to unique string values. The type of splat used to show this distribution is called a nominal splat.

HRESULT ShowXYCoords(long on);

Specifies whether (TRUE) or not (FALSE) to display the XY Coordinate grid.

HRESULT UseRandomColors(long on);

Specifies whether (TRUE) or not (FALSE) to assign a random color to each distinct geographical entity.

HRESULT ShowAnimationPanel(long on);

Specifies whether (TRUE) or not (FALSE) to show the animation panel. If there is no animation panel, it cannot be shown.

HRESULT UseSliderOnDrillThrough(long on);

Specifies whether (TRUE) or not (FALSE) the animation slider position should be used in constructing the drill through expression.

HRESULT Set2DSliderPositions(float slider1Pos,
float slider2Pos);

Allows you to programmatically alter the slider position. If the slider is one dimensional, the second argument is ignored.

HRESULT EnableSpinAnimation(long on);

Specifies whether or not the automatic spin animation should be enabled in the viewer. If on is set to TRUE, then it is possible to set the animation continuously spinning by doing a rotation and releasing the left mouse before you are done dragging.

HRESULT EnablePerspective(long on);

Sets whether or not to use perspective in the 3D viewer. TRUE specifies perspective projection. FALSE specifies orthogonal projection.

HRESULT SaveAnimationPaneImage(_bstr_ fileName);

Takes a snapshot of the animation control and saves it to a file. This method is primarily used for debugging and testing.

HRESULT SetAttributeOrder(ORDERCODE on);

Allows you to programmatically change the way the attributes are listed in the evidence visualizer. Possible values are: ORDER_BY_IMPORTANCE (the default) and ORDER_BY_DATABASE (use the database ordering).

HRESULT SubtractMinEvidence(long on);

Specifies whether to subtract the minimum amount of evidence from each value in the bars mode (see the MineSet Enterprise Edition Reference Guide.)

HRESULT SelectAttributeValue(_bstr_t attribute,
_bstr_t value);

Programmatically selects one of the attribute values and resulting probabilities.

HRESULT EnableEvidenceMode(long on);

Sets whether to show an evidence representation, or a probability representation. For the Evidence Visualizer, this means switching between showing the evidence cakes on the left, or the probability pies. See the MineSet Enterprise Edition Reference Guide for additional information about these modes.

long GetEvidenceMode();

Returns TRUE if the classifier visualizer is in the Evidence mode.

HRESULT SetNominalOrder(ORDERCODE ordercode);

Specifies how to order attribute values. Possible values are: ORDER_ALPHABETICALLY ORDER_BY_WEIGHT, ORDER_BY_LABEL

HRESULT SetViewerType(VIEWERCODE type) ;

Specifies whether to use the landscape style viewer or examiner viewer to display the scene. VIEWERCODE values are LANDSCAPE.VIEWER and EXAMINER.VIEWER

Drilling up and down is not available in the landscape viewer mode.

HRESULT SetLaplace(long on, float value);

Specifies whether or not to use Laplace correction. The second argument is the amount of Laplace correction to use. If the second argument is -1, then a default based on the data is used.

HRESULT SaveLabelPaneImage(_bstr_t fileName);

Takes a snapshot of the label probability pane and saves it to a file. This method is primarily used for debugging and testing.

HRESULT SelectLabelValue(_bstr_t value);

Programmatically selects one of the label values. After this method has been invoked, one of the classes in the probability pane on the right should be selected.

HRESULT SetWeightThresh(float percent);

Filters out objects with low weight. When the threshold is 0% all values are shown, no matter how small their weight; if value is set to 100% all values are removed from the scene.

HRESULT SetDetailThresh(float percent);

Changes the amount of detail in the scene. As the threshold is lowered, all attributes with lower importance values are removed from the scene.

HRESULT EnableEvidenceMode(long on);

Specifies whether to show an evidence representation, or a probability representation. In the Decision Table Visualizer, this determines whether the cakes show evidence (normalized conditional probabilities), or straight probabilities. See the MineSet Enterprise Edition Reference Guide for additional information about these modes.

HRESULT SetNominalOrder(ORDERCODE ordercode);

Specifies how to order attribute values. Possible values are: ORDER_ALPHABETICALLY, ORDER_BY_WEIGHT, and ORDER_BY_LABEL

HRESULT SetViewerType(VIEWERCODE type);

Specifies whether to use the landscape style viewer or examiner viewer to display the scene. Possible VIEWERCODE values are LANDSCAPE.VIEWER and EXAMINER.VIEWER.

HRESULT SetLaplace(long on, float value);

Specifies whether or not to use the Laplace correction. The second argument is the amount of Laplace correction to use.

HRESULT SaveLabelPaneImage(_bstr_t fileName);

Takes a snapshot of the label probability pane and saves it to a file. This method is primarily used for debugging and testing.

HRESULT SelectLabelValue(_bstr_t value);

Programmatically selects one of the label values. After this method has been invoked, one of the classes in the probability pane on the right should be selected.

HRESULT SetWeightThresh(float percent);

Filters out objects with low weight. When the threshold is 0% all values are shown, no matter how small their weight; if value is set to 100% all values are removed from the scene.

HRESULT SetDetailThresh(float percent);

Changes the amount of detail in the scene. As the threshold is increased, more detail is achieved through globally drilling down on all the cake charts until the maximum level of detail is reached at 100%.

HRESULT ShowHierarchyDialog();

Causes the Hierarchy Dialog box to be displayed. This is relevant only for decision tables and regression tables.

HRESULT ShowMarksDialog();

Brings up a dialog which allows you to mark nodes in the tree with colored flags.

HRESULT ShowOverviewDialog();

Brings up a dialog which shows a two dimensional view of the entire tree.

HRESULT ShowSearchDialog();

Brings up a dialog which lets you search for different attribute values for all the nodes in the tree hierarchy.

HRESULT Navigate(TREE_GOCODE code);

The equivalent of the navigation buttons on the right-hand strip of the Tree Visualizer Viewer. Code can take on any of the following values:

TREE_HOME—Resets the camera to the home position.
TREE_SETHOME—Sets a new home position.
TREE_VIEWALL—Positions the camera so the entire scene is in view.
TREE_BACK—Moves the position one step back in the navigation history (undo).
TREE_FORWARD—Moves the position one step forward in the navigation history (redo).
TREE_PARENT—Updates the selection to be the parent of the currently selected node, repositioning the camera to view it.
TREE_LEFT—Updates the selection to be the left sibling of current node.
TREE_RIGHT—Updates the selection to be the right sibling of current node.
TREE_FIRST—Updates selection to be the first (left) child of current node.
TREE_LAST—Updates selection to be the last (right) child of current node.

HRESULT IsValidNavigation(TREE_GOCODE c,
long *enabled);

Sets enabled to TRUE if the corresponding TREE_GOCODE is currently available. Otherwise sets it to FALSE.

HRESULT ShowBaseHeights(long on);

Toggles whether or not to show the base heights in the scene. If base heights are not shown, they appear simply as a flat box on the ground plane.

HRESULT ShowMarksFlags(long on);

Specifies whether to show the marks flags, if there are any.

void SetZeroStyle(DRAW_STYLE style);

Allows you to set how zero values are displayed. DRAW_STYLE style can take one of the following values: SOLID, HIDDEN or OUTLINE.

DRAW_STYLE GetZeroStyle();

Returns the current setting for how zero values are displayed using the variable DRAW_STYLE *style. This value will be either SOLID, HIDDEN, or OUTLINE.

HRESULT NormalizeSubtree();

Recomputes the heights for all nodes in the tree using the currently selected node as the 1.0 value.

HRESULT SaveInitialHierarchy(b_str_t fileName);

Primarily used for debugging and testing.

HRESULT SaveViewedHierarchy(b_str_t fileName);

Primarily used for debugging and testing.

HRESULT SaveOverviewImage(_bstr_t fileName);

Saves a snapshot of the overview dialog image. This method is primarily used for debugging and testing.

HRESULT SaveSearchPaths(_bstr_t fileName);

Saves a list of all the currently shown search paths. This method is primarily used for debugging and testing.