Visionary User's Guide

Visionary User's Guide
Appendix E: Viewer Control Interface

Home Contents Index Master Index New Book

Events

BeginNavigate Event

Occurs when the Visionary viewer control is about to navigate to a different scene, which may happen as a result of external automation, internal execution of an event, or the user clicking a tab or typing in the Jump To dialog box. The container application has an opportunity to cancel the pending navigation.

Visual Basic Syntax

Private Sub object_BeginNavigate(ByVal sceneName As String, 
ByVal xinches As Double, ByVal yinches As Double, ByVal 
zoomFactor As Double, cancel As Boolean)

C++ Syntax

void BeginNavigate(LPCTSTR sceneName, double xinches, double 
yinches, double zoomFactor, BOOL *cancel)

Arguments

Argument Description
sceneName
Name of the target scene

xinches
Horizontal location of the target viewpoint in inches, relative to the center of the scene

yinches
Vertical location of the target viewpoint in inches, relative to the center of the scene

zoomFactor
Zoom factor of the target viewpoint

cancel
A Boolean value that the container application can set to `TRUE` to cancel the jump, or to `FALSE` to allow it to proceed

NavigateComplete Event

Occurs after the Visionary viewer control has navigated to a different scene, which may have happened as a result of external automation, internal execution of an event, or the user clicking a tab or typing in the Jump To dialog box.

Visual Basic Syntax

Private Sub object_NavigateComplete(ByVal sceneName As String, 
ByVal xinches As Double, ByVal yinches As Double, ByVal 
zoomFactor As Double)

C++ Syntax

void NavigateComplete(LPCTSTR sceneName, double xinches, 
double yinches, double zoomFactor)

Arguments

Argument Description
sceneName
Name of the new scene

xinches
Horizontal location of the new viewpoint in inches, relative to the center of the scene

yinches
Vertical location of the new viewpoint in inches, relative to the center of the scene

zoomFactor
Zoom factor of the new viewpoint

ViewpointChange Event

Occurs after the user has moved to a different viewing location within the same scene, which may have happened as a result of external automation, internal execution of an event, the use of the scrollbar or navigation buttons, or the user typing in the Viewpoints dialog box.

Visual Basic Syntax

Private Sub object_ViewpointChange(ByVal xinches As Double, 
ByVal yinches As Double, ByVal zoomFactor As Double)

C++ Syntax

void ViewpointChange(double xinches, double yinches, double 
zoomFactor)

Arguments

Argument Description
xinches
Horizontal location of the new viewpoint in inches, relative to the center of the scene

yinches
Vertical location of the new viewpoint in inches, relative to the center of the scene

zoomFactor
Zoom factor of the new viewpoint

ParameterChange Event

Occurs after a global parameter has been set to a new value, which may have happened as a result of external automation, internal execution of an event, or the user typing in a value in the Runtime Settings dialog box. Only public global parameters may be set from the Runtime Settings dialog box.

Visual Basic Syntax

Private Sub object_ParameterChange(ByVal name As String, ByVal 
value As Variant)

C++ Syntax

void ParameterChange(LPCTSTR name, const VARIANT& value)

Arguments

Argument Description
name
Name of the global parameter that has been set

value
New value of the global parameter after it has been set

IssueQuery Event

Occurs after data has been requested from the database, which may have happened as a result of a jump or viewpoint change, selection of the refresh button on the navigation toolbar, or internal execution of an event.

Visual Basic Syntax

Private Sub object_IssueQuery(ByVal query As String)

C++ Syntax

void IssueQuery(LPCTSTR query)

Arguments

Argument Description
query
SQL statement that has been issued to the database

QueryCanceled Event

Occurs when a query is canceled, which may have happened as a result of external automation, or selection of the Stop button on the navigation toolbar.

Visual Basic Syntax

Private Sub object_QueryCanceled(ByVal cancelText As String)

C++ Syntax

void QueryCanceled(LPCTSTR cancelText)

Arguments

Argument Description
cancelText
Display version of the cancellation message

QueryProcessed Event

Occurs when an SQL statement has been executed successfully as the result of an event action.

Visual Basic Syntax

Private Sub object_QueryProcessed(ByVal resultText As String)

C++ Syntax

void QueryProcessed(LPCTSTR resultText)

Arguments

Argument Description
resultText
Describes the result of the executed query

QueryRowsReturned Event

Occurs after a set of rows is returned from the database in response to a request for data.

Visual Basic Syntax

Private Sub object_QueryRowsReturned(ByVal rowCount As Long, 
ByVal resultText As String)

C++ Syntax

void QueryRowsReturned(long rowCount, LPCTSTR resultText)

Arguments

Argument Description
rowCount
Number of rows returned from the database

resultText
Message displaying the number of rows returned and the name of the query executed

DataItemsDisplayed Event

Occurs after a set of rows from a data source have been processed, transformed into graphics, and displayed.

Visual Basic Syntax

Private Sub object_DataItemsDisplayed(ByVal itemCount As Long, 
ByVal statusText As String)

C++ Syntax

void DataItemsDisplayed(long itemCount, LPCTSTR statusText)

Arguments

Argument Description
itemCount
Number of rows processed into graphics

statusText
Message displaying the number of rows processed and the name of the data object owning the new data items

ControlStatusChange Event

Occurs when an embedded control such as the ActiveMovie or WebBrowser control reports a status message.

Visual Basic Syntax

Private Sub object_ControlStatusChange(ByVal statusText As 
String)

C++ Syntax

void ControlStatusChange(LPCTSTR statusText)

Arguments

Argument Description
statusText
Status message for the control

ExecError Event

Occurs when an execution error has happened.

Visual Basic Syntax

Private Sub object_ExecError(ByVal errCode as Integer, ByVal 
errMsg As String)

C++ Syntax

void ExecError(short errCode, LPCTSTR errMsg)

Arguments

Argument Description
errCode
Integer code for the error, which may be one of the following values:

EXEC_OUT_OF_MEMORY = `1`
EXEC_NO_WORMHOLE_HERE = `2`
EXEC_FAILED_TO_LAUNCH_APP = `3`
EXEC_MAX_ERR_COUNT_EXCEEDED = `4`
EXEC_QUERY_ERROR = `5`
EXEC_UNKNOWN_SCENE = `6`
EXEC_UNKNOWN_VIEWPOINT = `7`
EXEC_NO_WORMHOLE_TO_EXIT = `8`
EXEC_SCENE_ERROR = `9`
EXEC_FAILED_DATABASE_CONNECTION = `10`

errMsg
Description of the error

Visionary User's GuideAppendix E: Viewer Control Interface Home Contents Index Master Index New Book

Events

BeginNavigate Event

C++ Syntax

NavigateComplete Event

C++ Syntax

Arguments Argument Description sceneName Name of the new scene xinches Horizontal location of the new viewpoint in inches, relative to the center of the scene yinches Vertical location of the new viewpoint in inches, relative to the center of the scene zoomFactor Zoom factor of the new viewpoint

ViewpointChange Event

C++ Syntax

Arguments Argument Description xinches Horizontal location of the new viewpoint in inches, relative to the center of the scene yinches Vertical location of the new viewpoint in inches, relative to the center of the scene zoomFactor Zoom factor of the new viewpoint

ParameterChange Event

C++ Syntax

Arguments Argument Description name Name of the global parameter that has been set value New value of the global parameter after it has been set

IssueQuery Event

C++ Syntax

Arguments Argument Description query SQL statement that has been issued to the database

QueryCanceled Event

C++ Syntax

Arguments Argument Description cancelText Display version of the cancellation message

QueryProcessed Event

C++ Syntax

Arguments Argument Description resultText Describes the result of the executed query

QueryRowsReturned Event

C++ Syntax

Arguments Argument Description rowCount Number of rows returned from the database resultText Message displaying the number of rows returned and the name of the query executed

DataItemsDisplayed Event

C++ Syntax

Arguments Argument Description itemCount Number of rows processed into graphics statusText Message displaying the number of rows processed and the name of the data object owning the new data items

ControlStatusChange Event

C++ Syntax

Arguments Argument Description statusText Status message for the control

ExecError Event

C++ Syntax

Visionary User's Guide
Appendix E: Viewer Control Interface

Home Contents Index Master Index New Book

Arguments

Argument Description
xinches
Horizontal location of the new viewpoint in inches, relative to the center of the scene

yinches
Vertical location of the new viewpoint in inches, relative to the center of the scene

zoomFactor
Zoom factor of the new viewpoint

Arguments

Argument Description
name
Name of the global parameter that has been set

value
New value of the global parameter after it has been set

Arguments

Argument Description
query
SQL statement that has been issued to the database

Arguments

Argument Description
cancelText
Display version of the cancellation message

Arguments

Argument Description
resultText
Describes the result of the executed query

Arguments

Argument Description
rowCount
Number of rows returned from the database

resultText
Message displaying the number of rows returned and the name of the query executed

Arguments

Argument Description
itemCount
Number of rows processed into graphics

statusText
Message displaying the number of rows processed and the name of the data object owning the new data items

Arguments

Argument Description
statusText
Status message for the control