Skip to content

Class Spinnaker::GUI::GUIFactory

ClassList > GUI > GUIFactory

  • #include <SpinnakerGUI.h>

Public Functions

Type Name
bool ConnectGUILib (Spinnaker::CameraPtr camera)
void DisconnectGUILib ()
GUIFactory (void)
std::list< std::string > GetControlNameList ()
std::list< std::string > GetDialogNameList ()
int GetNumCtrls ()
int GetNumDlgs ()
void HideDlgByIndex (unsigned int index)
void HideDlgByName (std::string dialogName)
bool IsConnected ()
void ShowDlgByIndex (unsigned int index)
void ShowDlgByName (std::string dialogName)
~GUIFactory (void)

Public Static Functions

Type Name
CameraSelectionDlg * GetCameraSelectionDlg ()
PropertyGridDlg * GetPropertyGridDlg ()
ViewerDlg * GetViewer ()

Protected Attributes

Type Name
bool m_bisConnected
Spinnaker::GUI_WPF::GUIFactory * m_pWPFGUIFactory

Protected Static Attributes

Type Name
CameraSelectionDlg * m_pCameraSelectionDialog
PropertyGridDlg * m_pPropertyGridDialog
ViewerDlg * m_pViewer

Public Functions Documentation

function ConnectGUILib

bool GUI::GUIFactory::ConnectGUILib (
    Spinnaker::CameraPtr camera
) 

Connect GUI Factory to camera object

Parameters:

  • pointer to a camera object

Returns:

boolean indicating whether operation was successful


function DisconnectGUILib

void GUI::GUIFactory::DisconnectGUILib () 

Disconnect GUI Factory from camera object.


function GUIFactory

GUI::GUIFactory::GUIFactory (
    void
) 

Default constructor.


function GetControlNameList

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

Get dialog with specific name

Parameters:

  • string holding dialog name

function GetDialogNameList

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

Get a list of dialog names

Returns:

string list of dialog names


function GetNumCtrls

int GUI::GUIFactory::GetNumCtrls () 

Return number of controls contained in GUI Factory

Returns:

number of controls


function GetNumDlgs

int GUI::GUIFactory::GetNumDlgs () 

Get number of dialogs contained in GUI Factory

Returns:

number of dialogs


function HideDlgByIndex

void GUI::GUIFactory::HideDlgByIndex (
    unsigned int index
) 

Hide dialog at specific name list index

Parameters:

  • name index of dialog to be shown

function HideDlgByName

void GUI::GUIFactory::HideDlgByName (
    std::string dialogName
) 

Hide dialog with specific name

Parameters:

  • string holding dialog name

function IsConnected

inline bool GUI::GUIFactory::IsConnected () 

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

Returns:

boolean indicating connection status.


function ShowDlgByIndex

void GUI::GUIFactory::ShowDlgByIndex (
    unsigned int index
) 

Display dialog at specific name list index

Parameters:

  • name index of dialog to be shown

function ShowDlgByName

void GUI::GUIFactory::ShowDlgByName (
    std::string dialogName
) 

Display dialog with specific name

Parameters:

  • string holding dialog name

function ~GUIFactory

GUI::GUIFactory::~GUIFactory (
    void
) 

Default destructor.


Public Static Functions Documentation

function GetCameraSelectionDlg

static CameraSelectionDlg * GUI::GUIFactory::GetCameraSelectionDlg () 

Statically Get Camera Selection Window from GUI Factory

Returns:

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


function GetPropertyGridDlg

static PropertyGridDlg * GUI::GUIFactory::GetPropertyGridDlg () 

Statically Get PropertyGridWindow from GUI Factory.

Returns:

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


function GetViewer

static ViewerDlg * GUI::GUIFactory::GetViewer () 

Statically Get Image Drawing Window

Returns:

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


Protected Attributes Documentation

variable m_bisConnected

bool Spinnaker::GUI::GUIFactory::m_bisConnected;

variable m_pWPFGUIFactory

Spinnaker::GUI_WPF::GUIFactory* Spinnaker::GUI::GUIFactory::m_pWPFGUIFactory;

Protected Static Attributes Documentation

variable m_pCameraSelectionDialog

CameraSelectionDlg* Spinnaker::GUI::GUIFactory::m_pCameraSelectionDialog;

variable m_pPropertyGridDialog

PropertyGridDlg* Spinnaker::GUI::GUIFactory::m_pPropertyGridDialog;

variable m_pViewer

ViewerDlg* Spinnaker::GUI::GUIFactory::m_pViewer;


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