Inheritance diagram for osg::ApplicationUsage:

Collaboration diagram for osg::ApplicationUsage:

[legend]

Public Types
enum	Type { NO_HELP = 0x0, COMMAND_LINE_OPTION = 0x1, ENVIRONMENTAL_VARIABLE = 0x2, KEYBOARD_MOUSE_BINDING = 0x4, HELP_ALL = KEYBOARD_MOUSE_BINDING\|ENVIRONMENTAL_VARIABLE\|COMMAND_LINE_OPTION }

typedef std::map< std::string, std::string >	UsageMap

Public Member Functions
	ApplicationUsage (const std::string &commandLineUsage)

void	setApplicationName (const std::string &name)
	The ApplicationName is often displayed when logging errors, and frequently incorporated into the Description (below). More...

const std::string &	getApplicationName () const

void	setDescription (const std::string &desc)
	If non-empty, the Description is typically shown by the Help Handler as text on the Help display (which also lists keyboard abbreviations. More...

const std::string &	getDescription () const

void	addUsageExplanation (Type type, const std::string &option, const std::string &explanation)

void	setCommandLineUsage (const std::string &explanation)

const std::string &	getCommandLineUsage () const

void	addCommandLineOption (const std::string &option, const std::string &explanation, const std::string &defaultValue="")

void	setCommandLineOptions (const UsageMap &usageMap)

const UsageMap &	getCommandLineOptions () const

void	setCommandLineOptionsDefaults (const UsageMap &usageMap)

const UsageMap &	getCommandLineOptionsDefaults () const

void	addEnvironmentalVariable (const std::string &option, const std::string &explanation, const std::string &defaultValue="")

void	setEnvironmentalVariables (const UsageMap &usageMap)

const UsageMap &	getEnvironmentalVariables () const

void	setEnvironmentalVariablesDefaults (const UsageMap &usageMap)

const UsageMap &	getEnvironmentalVariablesDefaults () const

void	addKeyboardMouseBinding (const std::string &prefix, int key, const std::string &explanation)

void	addKeyboardMouseBinding (int key, const std::string &explanation)

void	addKeyboardMouseBinding (const std::string &option, const std::string &explanation)

void	setKeyboardMouseBindings (const UsageMap &usageMap)

const UsageMap &	getKeyboardMouseBindings () const

void	getFormattedString (std::string &str, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap())

void	write (std::ostream &output, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap())

void	write (std::ostream &output, unsigned int type=COMMAND_LINE_OPTION, unsigned int widthOfOutput=80, bool showDefaults=false)

void	writeEnvironmentSettings (std::ostream &output)

Public Member Functions inherited from osg::Referenced
	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

OpenThreads::Mutex *	getRefMutex () const

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Static Public Member Functions
static ApplicationUsage *	instance ()

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Protected Attributes
std::string	_applicationName

std::string	_description

std::string	_commandLineUsage

UsageMap	_commandLineOptions

UsageMap	_environmentalVariables

UsageMap	_keyboardMouse

UsageMap	_environmentalVariablesDefaults

UsageMap	_commandLineOptionsDefaults

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

OpenThreads::Mutex *	_refMutex

int	_refCount

void *	_observerSet

Additional Inherited Members
Protected Member Functions inherited from osg::Referenced
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Member Function Documentation

◆ setApplicationName()

void osg::ApplicationUsage::setApplicationName ( const std::string & name )

inline

The ApplicationName is often displayed when logging errors, and frequently incorporated into the Description (below).

◆ setDescription()

void osg::ApplicationUsage::setDescription ( const std::string & desc )

inline

If non-empty, the Description is typically shown by the Help Handler as text on the Help display (which also lists keyboard abbreviations.

The documentation for this class was generated from the following file:

/home/karlu20/private/installs/OpenSceneGraph/include/osg/ApplicationUsage

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ setApplicationName()

◆ setDescription()