Skip to content

Class Spinnaker::GUI_WPF::GUIFactory

ClassList > GUI_WPF > GUIFactory

More...

  • #include <SpinnakerGUI_WPF.h>

Public Functions

Type Name
bool ConnectGUILibrary (Spinnaker::CameraPtr * camera)
void DisconnectGUILibrary ()
GUIFactory ()
CameraSelectionWindow * GetCameraSelectionWindow ()
std::list< std::string > GetControlNameList ()
std::list< std::string > GetDialogNameList ()
ImageDrawingWindow * GetImageDrawingWindow ()
int GetNumOfControls ()
int GetNumOfDialogs ()
PropertyGridWindow * GetPropertyGridWindow ()
void HideDialogByIndex (int index)
void HideDialogByName (std::string dialogName)
bool IsConnected ()
void ShowDialogByIndex (int index)
void ShowDialogByName (std::string dialogName)
~GUIFactory ()

Detailed Description

The GUIFactory object represents a C++ object that provides access to GUI objects such as CameraSelectionWindow, PropertyGridWindow and dialogs defined in GUI XML

Public Functions Documentation

function ConnectGUILibrary

bool GUI_WPF::GUIFactory::ConnectGUILibrary (
    Spinnaker::CameraPtr * camera
) 

Connect GUI Factory to camera object

Parameters:

  • camera pointer to a camera object

Returns:

boolean indicating whether operation was successful


function DisconnectGUILibrary

void GUI_WPF::GUIFactory::DisconnectGUILibrary () 

Disconnect GUI Factory from camera object.


function GUIFactory

GUI_WPF::GUIFactory::GUIFactory () 

Default constructor.


function GetCameraSelectionWindow

CameraSelectionWindow * GUI_WPF::GUIFactory::GetCameraSelectionWindow () 

Get Camera Selection Window from GUI Factory

Returns:

A pointer to CameraSelectionWindow. User has ownership of this pointer.


function GetControlNameList

std::list< std::string > GUI_WPF::GUIFactory::GetControlNameList () 

Return a string list of controls

Returns:

list of control names


function GetDialogNameList

std::list< std::string > GUI_WPF::GUIFactory::GetDialogNameList () 

Get a list of dialog names

Returns:

string list of dialog names


function GetImageDrawingWindow

ImageDrawingWindow * GUI_WPF::GUIFactory::GetImageDrawingWindow () 

Get Image Drawing Window

Returns:

A pointer to ImageDrawingWindow. User has ownership of this pointer.


function GetNumOfControls

int GUI_WPF::GUIFactory::GetNumOfControls () 

Return number of controls contained in GUI Factory

Returns:

number of controls


function GetNumOfDialogs

int GUI_WPF::GUIFactory::GetNumOfDialogs () 

Get number of dialogs contained in GUI Factory

Returns:

number of dialogs


function GetPropertyGridWindow

PropertyGridWindow * GUI_WPF::GUIFactory::GetPropertyGridWindow () 

Get PropertyGridWindow from GUI Factory.

Returns:

A pointer to PropertyGridWindow. User has ownership of this pointer.


function HideDialogByIndex

void GUI_WPF::GUIFactory::HideDialogByIndex (
    int index
) 

Hide dialog at specific name list index

Parameters:

  • index name index of dialog to be hidden

function HideDialogByName

void GUI_WPF::GUIFactory::HideDialogByName (
    std::string dialogName
) 

Hide dialog by specific name

Parameters:

  • dialogName name of dialog to be hidden

function IsConnected

bool GUI_WPF::GUIFactory::IsConnected () 

Get a boolean indicating whether GUI Factory is connected to a camera object.

Returns:

boolean indicating connection status.


function ShowDialogByIndex

void GUI_WPF::GUIFactory::ShowDialogByIndex (
    int index
) 

Display dialog at specific name list index

Parameters:

  • index name index of dialog to be shown

function ShowDialogByName

void GUI_WPF::GUIFactory::ShowDialogByName (
    std::string dialogName
) 

Display dialog with specific name

Parameters:

  • dialogName string holding dialog name

function ~GUIFactory

GUI_WPF::GUIFactory::~GUIFactory () 

Default destructor.



The documentation for this class was generated from the following file /workspace/include/GUI/SpinnakerGUI_WPF.h