OpenSceneGraph 3.6.5
ApplicationUsage
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_APPLICATIONUSAGE
15#define OSG_APPLICATIONUSAGE 1
16
17#include <osg/Referenced>
18
19#include <map>
20#include <string>
21#include <ostream>
22
23namespace osg {
24
26{
27 public:
28
30
32
33 ApplicationUsage(const std::string& commandLineUsage);
34
35 typedef std::map<std::string,std::string> UsageMap;
36
37
39 void setApplicationName(const std::string& name) { _applicationName = name; }
40 const std::string& getApplicationName() const { return _applicationName; }
41
44 void setDescription(const std::string& desc) { _description = desc; }
45 const std::string& getDescription() const { return _description; }
46
55
56 void addUsageExplanation(Type type,const std::string& option,const std::string& explanation);
57
58 void setCommandLineUsage(const std::string& explanation) { _commandLineUsage=explanation; }
59 const std::string& getCommandLineUsage() const { return _commandLineUsage; }
60
61
62 void addCommandLineOption(const std::string& option,const std::string& explanation, const std::string &defaultValue = "");
63
64 void setCommandLineOptions(const UsageMap& usageMap) { _commandLineOptions=usageMap; }
66
69
70
71 void addEnvironmentalVariable(const std::string& option,const std::string& explanation, const std::string& defaultValue = "");
72
75
78
79
80 void addKeyboardMouseBinding(const std::string& prefix, int key, const std::string& explanation);
81 void addKeyboardMouseBinding(int key, const std::string& explanation);
82 void addKeyboardMouseBinding(const std::string& option,const std::string& explanation);
83
84 void setKeyboardMouseBindings(const UsageMap& usageMap) { _keyboardMouse=usageMap; }
86
87
88 void getFormattedString(std::string& str, const UsageMap& um,unsigned int widthOfOutput=80,bool showDefaults=false,const UsageMap& ud=UsageMap());
89
90 void write(std::ostream& output,const UsageMap& um,unsigned int widthOfOutput=80,bool showDefaults=false,const UsageMap& ud=UsageMap());
91
92 void write(std::ostream& output,unsigned int type=COMMAND_LINE_OPTION, unsigned int widthOfOutput=80,bool showDefaults=false);
93
94 void writeEnvironmentSettings(std::ostream& output);
95
96 protected:
97
98 virtual ~ApplicationUsage() {}
99
100 std::string _applicationName;
101 std::string _description;
102 std::string _commandLineUsage;
108
109};
110
112{
113 public:
114
116 ApplicationUsageProxy(ApplicationUsage::Type type,const std::string& option,const std::string& explanation)
117 {
118 ApplicationUsage::instance()->addUsageExplanation(type,option,explanation);
119 }
120};
121
122}
123
124#endif
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
void setEnvironmentalVariablesDefaults(const UsageMap &usageMap)
Definition ApplicationUsage:76
UsageMap _commandLineOptions
Definition ApplicationUsage:103
const std::string & getDescription() const
Definition ApplicationUsage:45
const std::string & getApplicationName() const
Definition ApplicationUsage:40
void addKeyboardMouseBinding(int key, const std::string &explanation)
void setCommandLineUsage(const std::string &explanation)
Definition ApplicationUsage:58
const UsageMap & getCommandLineOptionsDefaults() const
Definition ApplicationUsage:68
const UsageMap & getEnvironmentalVariablesDefaults() const
Definition ApplicationUsage:77
void addUsageExplanation(Type type, const std::string &option, const std::string &explanation)
std::string _commandLineUsage
Definition ApplicationUsage:102
void setCommandLineOptions(const UsageMap &usageMap)
Definition ApplicationUsage:64
void write(std::ostream &output, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap())
UsageMap _environmentalVariablesDefaults
Definition ApplicationUsage:106
void writeEnvironmentSettings(std::ostream &output)
void addCommandLineOption(const std::string &option, const std::string &explanation, const std::string &defaultValue="")
void write(std::ostream &output, unsigned int type=COMMAND_LINE_OPTION, unsigned int widthOfOutput=80, bool showDefaults=false)
const UsageMap & getEnvironmentalVariables() const
Definition ApplicationUsage:74
void setEnvironmentalVariables(const UsageMap &usageMap)
Definition ApplicationUsage:73
virtual ~ApplicationUsage()
Definition ApplicationUsage:98
ApplicationUsage()
Definition ApplicationUsage:31
const UsageMap & getCommandLineOptions() const
Definition ApplicationUsage:65
void getFormattedString(std::string &str, const UsageMap &um, unsigned int widthOfOutput=80, bool showDefaults=false, const UsageMap &ud=UsageMap())
std::map< std::string, std::string > UsageMap
Definition ApplicationUsage:35
void setKeyboardMouseBindings(const UsageMap &usageMap)
Definition ApplicationUsage:84
std::string _description
Definition ApplicationUsage:101
UsageMap _commandLineOptionsDefaults
Definition ApplicationUsage:107
ApplicationUsage(const std::string &commandLineUsage)
void setDescription(const std::string &desc)
If non-empty, the Description is typically shown by the Help Handler as text on the Help display (whi...
Definition ApplicationUsage:44
const UsageMap & getKeyboardMouseBindings() const
Definition ApplicationUsage:85
void addEnvironmentalVariable(const std::string &option, const std::string &explanation, const std::string &defaultValue="")
void addKeyboardMouseBinding(const std::string &prefix, int key, const std::string &explanation)
void setCommandLineOptionsDefaults(const UsageMap &usageMap)
Definition ApplicationUsage:67
UsageMap _keyboardMouse
Definition ApplicationUsage:105
Type
Definition ApplicationUsage:48
@ ENVIRONMENTAL_VARIABLE
Definition ApplicationUsage:51
@ KEYBOARD_MOUSE_BINDING
Definition ApplicationUsage:52
@ HELP_ALL
Definition ApplicationUsage:53
@ NO_HELP
Definition ApplicationUsage:49
@ COMMAND_LINE_OPTION
Definition ApplicationUsage:50
void setApplicationName(const std::string &name)
The ApplicationName is often displayed when logging errors, and frequently incorporated into the Desc...
Definition ApplicationUsage:39
void addKeyboardMouseBinding(const std::string &option, const std::string &explanation)
UsageMap _environmentalVariables
Definition ApplicationUsage:104
const std::string & getCommandLineUsage() const
Definition ApplicationUsage:59
static ApplicationUsage * instance()
std::string _applicationName
Definition ApplicationUsage:100
ApplicationUsageProxy(ApplicationUsage::Type type, const std::string &option, const std::string &explanation)
register an explanation of commandline/environmentvariable/keyboard mouse usage.
Definition ApplicationUsage:116
Base class for providing reference counted objects.
Definition Referenced:44
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.