The Vish Visualization Shell 0.3
Vish
Public Member Functions | List of all members
Wizt::VCreatorProperty< ID > Class Template Reference

A set of property elements for VCreator objects. More...

#include <ocean/plankton/VCreatorProperties.hpp>

Inheritance diagram for Wizt::VCreatorProperty< ID >:
Wizt::VCreatorPropertyBase Wizt::VCreatorPropertyElements

Public Member Functions

 VCreatorProperty ()
 Empty constructor.
 
 VCreatorProperty (const string &name)
 Construct from a single string and assign to ID entry.
 
template<unsigned ID1, unsigned ID2>
 VCreatorProperty (const VCreatorProperty< ID1 > &l, const VCreatorProperty< ID2 > &r)
 Merge two property sets.
 
template<unsigned ID1>
 VCreatorProperty (const VCreatorProperty< ID1 > &vp)
 Construct from another indexed set.
 
- Public Member Functions inherited from Wizt::VCreatorPropertyBase
string & Application ()
 Application domain.
 
const string & Application () const
 Application domain.
 
string & Arguments ()
 Textual description of acceptable arguments, see POLYMORPHY.
 
const string & Arguments () const
 Textual description of acceptable arguments, see POLYMORPHY.
 
void assign (const VCreatorPropertyBase &l)
 Assignment - copy only those strings that are non-empty, otherwise status quo is kept.
 
string Author () const
 authorship information, looked up from authors.txt
 
string & AuthorKey ()
 authorship information
 
const string & AuthorKey () const
 author key
 
string & Category ()
 Group of creators.
 
const string & Category () const
 Group of creators.
 
string & Description ()
 Descriptive name, UTF8 characters allowed.
 
const string & Description () const
 Descriptive name, UTF8 characters allowed.
 
string & helpurl ()
 relative URL for integrated help for this creator
 
const string & helpurl () const
 relative URL for integrated help for this creator
 
string & Identifier ()
 Identifier within this group.
 
const string & Identifier () const
 Identifier within this group.
 
string keyname (const char separator[]="/") const
 globally unique name
 
std::string & operator() (unsigned i)
 Retrieve property i, writeable.
 
const string & operator() (unsigned i) const
 Retrieve property i, readonly.
 
string & OperatorName ()
 Ideally a single UTF8 character, for operators.
 
const string & OperatorName () const
 Ideally a single UTF8 character, for operators.
 
string & shorthelp ()
 short help string, for tooltip descriptions
 
const string & shorthelp () const
 short help string, for tooltip descriptions
 
string & SourceFile ()
 Source code file.
 
const string & SourceFile () const
 Source code file.
 
string & url ()
 Weburl for further info about this object.
 
const string & url () const
 Weburl for further info about this object.
 

Additional Inherited Members

- Public Types inherited from Wizt::VCreatorPropertyElements
enum  {
  CATEGORY , TEXTIDENTIFIER , POLYMORPHY , DESCRIPTION ,
  OPERATORNAME , OPERATORFONT , SHORTHELP , AUTHOR ,
  HELPURL , URL , APPLICATION , APPLICATION_DOMAIN = APPLICATION ,
  SOURCE_FILE , COMPILATION_DATE , RESERVED_1 , RESERVED_2 ,
  RESERVED_3 , RESERVED_4 , MAX_PROPERTY , APPLICATION_SEPARATOR = ';'
}
 
- Protected Types inherited from Wizt::VCreatorPropertyBase
enum  { NumberOfProperties = VCreatorPropertyElements::MAX_PROPERTY }
 
- Protected Attributes inherited from Wizt::VCreatorPropertyBase
std::string txt [NumberOfProperties]
 A textual description for each property.
 

Detailed Description

template<unsigned ID>
class Wizt::VCreatorProperty< ID >

A set of property elements for VCreator objects.

See also
Panthalassa syntax for object construction.
Examples
AnemoneBoundingVolume.cpp, Background.cpp, DynamicBackground.cpp, InteractivePoint.cpp, MonochromeBackground.cpp, and QuadDemo.cpp.