Choreonoid  1.5
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
cnoid::ViewManager Class Reference

#include <ViewManager.h>

Classes

class  Factory
 
class  FactoryBase
 
class  ViewStateInfo
 

Public Types

enum  InstantiationType { SINGLE_DEFAULT, SINGLE_OPTIONAL, MULTI_DEFAULT, MULTI_OPTIONAL }
 

Public Member Functions

 ViewManager (ExtensionManager *ext)
 
 ~ViewManager ()
 
template<class ViewType >
ViewType * registerClass (const std::string &className, const std::string &defaultInstanceName, ViewManager::InstantiationType itype=ViewManager::SINGLE_OPTIONAL)
 

Static Public Member Functions

static void initializeClass (ExtensionManager *ext)
 
static ViewClass * viewClass (const std::type_info &view_type_info)
 
static View * getOrCreateView (const std::string &moduleName, const std::string &className)
 
static View * getOrCreateView (const std::string &moduleName, const std::string &className, const std::string &instanceName)
 
static View * getOrCreateViewOfDefaultName (const std::string &defaultName)
 
static std::vector< View * > allViews ()
 
static std::vector< View * > activeViews ()
 
template<class ViewType >
static ViewType * getOrCreateView (bool doMountCreatedView=false)
 
template<class ViewType >
static ViewType * getOrCreateView (const std::string &instanceName, bool doMountCreatedView=false)
 
template<class ViewType >
static ViewType * findView ()
 
template<class ViewType >
static ViewType * findView (const std::string &instanceName)
 
static bool isPrimalInstance (View *view)
 
static bool storeViewStates (ArchivePtr archive, const std::string &key)
 
static void restoreViews (ArchivePtr archive, const std::string &key, ViewStateInfo &out_viewStateInfo)
 
static bool restoreViewStates (ViewStateInfo &info)
 
static SignalProxy< void(View *view)> sigViewCreated ()
 
static SignalProxy< void(View *view)> sigViewActivated ()
 
static SignalProxy< void(View *view)> sigViewDeactivated ()
 
static SignalProxy< void(View *view)> sigViewRemoved ()
 

Member Enumeration Documentation

§ InstantiationType

enum cnoid::ViewManager::InstantiationType
Enumerator
SINGLE_DEFAULT 
SINGLE_OPTIONAL 
MULTI_DEFAULT 
MULTI_OPTIONAL 

Constructor & Destructor Documentation

§ ViewManager()

ViewManager::ViewManager ( ExtensionManager *  ext)

§ ~ViewManager()

ViewManager::~ViewManager ( )

Member Function Documentation

§ activeViews()

std::vector< View * > ViewManager::activeViews ( )
static

§ allViews()

std::vector< View * > ViewManager::allViews ( )
static

§ findView() [1/2]

template<class ViewType >
static ViewType* cnoid::ViewManager::findView ( )
inlinestatic

§ findView() [2/2]

template<class ViewType >
static ViewType* cnoid::ViewManager::findView ( const std::string &  instanceName)
inlinestatic

§ getOrCreateView() [1/4]

View * ViewManager::getOrCreateView ( const std::string &  moduleName,
const std::string &  className 
)
static

§ getOrCreateView() [2/4]

View * ViewManager::getOrCreateView ( const std::string &  moduleName,
const std::string &  className,
const std::string &  instanceName 
)
static

§ getOrCreateView() [3/4]

template<class ViewType >
static ViewType* cnoid::ViewManager::getOrCreateView ( bool  doMountCreatedView = false)
inlinestatic

§ getOrCreateView() [4/4]

template<class ViewType >
static ViewType* cnoid::ViewManager::getOrCreateView ( const std::string &  instanceName,
bool  doMountCreatedView = false 
)
inlinestatic

§ getOrCreateViewOfDefaultName()

View * ViewManager::getOrCreateViewOfDefaultName ( const std::string &  defaultName)
static

This is implemented for the compatibility to version 1.4 or earlier. This is only used for loading the view layout configuration created by those verions.

§ initializeClass()

void ViewManager::initializeClass ( ExtensionManager *  ext)
static

§ isPrimalInstance()

bool ViewManager::isPrimalInstance ( View *  view)
static

§ registerClass()

template<class ViewType >
ViewType* cnoid::ViewManager::registerClass ( const std::string &  className,
const std::string &  defaultInstanceName,
ViewManager::InstantiationType  itype = ViewManager::SINGLE_OPTIONAL 
)
inline
Returns
If itype is SINGLE_DEFAULT or MULTI_DEFAULT, the default instance created by this function is returned. Otherwise null pointer is returned.

§ restoreViews()

void ViewManager::restoreViews ( ArchivePtr  archive,
const std::string &  key,
ViewManager::ViewStateInfo &  out_viewStateInfo 
)
static

§ restoreViewStates()

bool ViewManager::restoreViewStates ( ViewStateInfo &  info)
static

§ sigViewActivated()

SignalProxy< void(View *view)> ViewManager::sigViewActivated ( )
static

§ sigViewCreated()

SignalProxy< void(View *view)> ViewManager::sigViewCreated ( )
static

§ sigViewDeactivated()

SignalProxy< void(View *view)> ViewManager::sigViewDeactivated ( )
static

§ sigViewRemoved()

SignalProxy< void(View *view)> ViewManager::sigViewRemoved ( )
static

§ storeViewStates()

bool ViewManager::storeViewStates ( ArchivePtr  archive,
const std::string &  key 
)
static

§ viewClass()

ViewClass * ViewManager::viewClass ( const std::type_info &  view_type_info)
static
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.12