Wizt::VParameter Class Reference

A VParameter enables VObjects to retrieve certain values. More...

#include </home/werner/origo/vish/ocean/plankton/VParameter.hpp>

List of all members.

Classes

• struct UserIterator

  Iterator object that allows to inspect the objects that (might) be using the current VParameter under a given alias name. More...
  

Public Types

• typedef std::list< RefPtr
  < VParameterConnectionConstraint > > VParameterConnectionConstraintList_t

Public Member Functions

• void AddAction (const RefPtr< ValueActionBase > &VAB)

  Add an action to the change of the underlying value.
  

• void AddUndoAction (const RefPtr< VUndoAction > &what, int MaxActions)

  Add an undo action element to the undo stack.
  

• Ageable & age (const RefPtr< ValuePool > &VP) const

  The age of this parameter (it's the value's age)
  

• const bool & autoLocalizeFlag () const
• bool & autoLocalizeFlag ()
• int ConnectibilityMismatch (const VParameter &OutputCandidate) const
• virtual const RefPtr< VParameter > copy () const =0
• virtual RefPtr< VValueBase > createLocalVariable (const RefPtr< ValuePool > &GhostValues) const =0

  Cast a shadow of the current parameter's value onto the given ValuePool.
  

• const RefPtr
  < VCreationPreferences > & CreationPreferences () const

  The creation preferences.
  

• override const RefPtr
  < VValueBase > & DefaultValue () const

  Return a reference to an eventually associated default or global value of the associated variable.
  

• template<class Type , class Member > void exportMember (Member Type::*MemberPointer, const string &membername)
• const RefPtr< VValueBase > & getGlobalValue () const
• RefPtr< VValueBase > getLocalValue (const RefPtr< ValuePool > &VP, const string &member, bool forceLocal) const

  Get the local shadow of the variable.
  

• const WeakPtr< VManagedObject > & getOwner () const
• RefPtr< VValueBase > getProperty (const string &PropertyName) const

  Get a certain property.
  

• const type_info & getType () const

  Get the parameter type.
  

• const type_info & getType (const string &member) const

  Get the parameter type.
  

• RefPtr< VValueBase > getValue (const RefPtr< ValuePool > &VP, const string &member) const
• template<class Type > bool getValue (Type &Variable, const RefPtr< ValuePool > &VP, const string &member) const

  Get the current value of the parameter.
  

• string getValueAsText (const RefPtr< ValuePool > &VP, const string &member, bool forceLocalCreation)

  Get the parameter to a certain value as some textual description.
  

• RefPtr< VValueBase > getValueBase (const RefPtr< ValuePool > &VP, const string &member, bool forceLocal) const

  Retrieve a local value, if one exists, or the global value otherwise.
  

• void Globalize (const RefPtr< ValuePool > &GhostValues)

  Make the values of this parameter global, initializing the values from the given value pool.
  

• void includeUser (const WeakPtr< VManagedObject > &UsingObject, const string &alias)

  Inform the VParameter that some object will be using it under a specific name.
  

• bool isLocal () const

  Tell if the current parameter is local relative to a given context.
  

• int iterateProperties (ValueMap::iterator &it)

  Iterate over all properties of this parameter.
  

• int iterateUserAliases (UserIterator &, const WeakPtr< VManagedObject > &TheUsingObject) const

  Iterate over all aliases of this parameter as seen from a a specific object.
  

• int iterateUsers (UserIterator &) const

  Iterate over all users of this object, providing the alias names for this parameter.
  

• void Localize ()

  Set a parameter to have local values relative to some value pool.
  

• const string & Name () const

  Retrieve the name of this parameter.
  

• virtual RefPtr< VValueBase > newValue () const =0

  Create a new value with same value as this global one.
  

• void notifyInputs (const ValuePoolPtr &VP, const ValueNotifierList *Exclude, const WeakPtr< ValueNotifier > &issuer=NullPtr()) const

  Broadcast a value change event to all listening notifiers.
  

• size_t NumberOfProperties () const

  How many properties are associated at this parameter.
  

• void removeLocalVariable (const RefPtr< ValuePool > &GhostValues) const
• void removeUser (const WeakPtr< VManagedObject > &UsingObject, const string &alias)

  Inform a VParameter that some object will no longer be using it under the given alias name.
  

• void sendNotification (const WeakPtr< ValueNotifier > &issuer=NullPtr(), const ValueNotifierList *Exclude=0, const ValuePoolPtr &VP=NullPtr())

  If some parameter properties have been changed, send a notification event to all input instances.
  

• virtual bool setGlobalValue (const RefPtr< VValueBase > &value, const string &member) const =0
• void setName (const string &s)

  Set the name of this parameter.
  

• void setOwner (const WeakPtr< VManagedObject > &Obj)
• void setProperty (const string &s, const RefPtr< VValueBase > &V, const WeakPtr< ValueNotifier > &issuer=NullPtr(), const ValueNotifierList *Exclude=0, const ValuePoolPtr &Ctx=NullPtr())

  Set a property of this parameter, and issue a notification event relative to the global context to all listening input instances.
  

• template<class Type > void setPropertyValue (const string &s, const Type &V, const WeakPtr< ValueNotifier > &issuer=NullPtr(), const ValueNotifierList *Exclude=0)

  Set a typed property of this parameter and issue a notification event to all connected input instances.
  

• void setSilentProperty (const string &s, const RefPtr< VValueBase > &V)

  Set a parameter's property without sending out a notification event.
  

• template<class Type > void setSilentPropertyValue (const string &s, const Type &V)
• void setSource (const WeakPtr< VManagedObject > &Obj)
• template<class Type > bool setValue (const Type &Variable, const RefPtr< ValuePool > &VP, const string &member, bool forceLocalCreation, const WeakPtr< ValueNotifier > &issuer, const ValueNotifierList *Exclude=0, const ValueMap *vParam=0) const

  Set the parameter to a certain value and inform all input listeners about this change.
  

• bool setValueFromText (const string &VariableText, const RefPtr< ValuePool > &VP, const string &member, bool forceLocalCreation, const WeakPtr< ValueNotifier > &issuer, const ValueNotifierList *Exclude=0, const ValueMap *vParam=0) const

  Set the parameter to a certain value from some textual description and inform all input listeners about this change.
  

• const WeakPtr< VManagedObject > & Source () const

  Retrieve source object of the value.
  

• void touch (const RefPtr< ValuePool > &VP) const

  Touch the parameter.
  

• MemCore::time_t update (const RefPtr< ValuePool > &VP, const Ageable &Other)

  Update from time parameter.
  

• void updateProperties (const ValueMap &ThePropertyList, const WeakPtr< ValueNotifier > &issuer=NullPtr(), const ValueNotifierList *Exclude=0)

  Update all properties from the given list.
  

• const RefPtr< VValueBase > & val () const
• VParameter (const RefPtr< VValueBase > &value, const string &initial_name, const RefPtr< VCreationPreferences > &CP)
• ~VParameter ()

  Destructor.
  

Public Attributes

• int relevance

  An optional setting to specify how relevant this parameter is for the entire scene.
  

• VParameterConnectionConstraintList_t VParameterConnectionConstraintList

Protected Types

• typedef std::multimap< WeakPtr
  < VManagedObject >
  , std::string > Users_t

Protected Attributes

• bool autoLocalize
• RefPtr< VCreationPreferences > CP
• std::list< RefPtr
  < ValueActionBase > > myActions
• Users_t myUsers
• string name
• WeakPtr< VManagedObject > sourceObject
• RefPtr< VValueBase > value
• ValueMap * VP

---

Detailed Description

A VParameter enables VObjects to retrieve certain values.

It provides

• name information
• type information
• value retrieval functionality
• value modification and notification broadcasting. Certain VObjects may listen to the same VParameter instance. Also, a specific VParameter object may be managed through one or many input objects.

A parameter that is associated with one or more VObjects. The same VParameter may be shared among multiple VObjects. For each VObject, it may be accessed via another name which is relative to this VObject. Moreover, there may be many VInputBase objects associated with the same VParameter.

VParameters moreover possess

1. Creation Preferences - used during construction, originating from the Creator of this VParameter
2. Properties - used at lifetime to specify inputs, for instance a range of a slider, to be used across all possible Creators, if possible

---

Constructor & Destructor Documentation

Wizt::VParameter::VParameter	(	const RefPtr< VValueBase > &	value,
		const string &	initial_name,
		const RefPtr< VCreationPreferences > &	CP
	)

Parameters:

value

An initial default value, preferably an actually stored value such as VValue<>. Note that child class VValueParameter<> implements the creation of such a default value by virtue of an provided initial type, so using this child class is more convenient than the generic VParameter class in most cases. Only exception is when this initial value should not be a VValue<>, but something else.

However, note that VParameter is an abstract class and cannot be instantiated anyway on their own.

---

Member Function Documentation

virtual RefPtr<VValueBase> Wizt::VParameter::createLocalVariable

(

const RefPtr< ValuePool > &

GhostValues

)

const [pure virtual]

Cast a shadow of the current parameter's value onto the given ValuePool.

It the same ValuePool is specified on future retrieval, then all getValue()/setValue() calls will operate on this shadow instead of the global image.

Implemented in Wizt::VValueParameter, Wizt::VValueParameter< VThreadManager >, Wizt::VValueParameter< GLFontManager >, and Wizt::VAbstractValueParameter.

RefPtr< VValueBase > Wizt::VParameter::getLocalValue	(	const RefPtr< ValuePool > &	VP,
		const string &	member,
		bool	forceLocal
	)		const

Get the local shadow of the variable.

Returns:

NullPtr() if no such shadow exists.

Looking for eventual shadow value in value pool VP.

template<class Type >

bool Wizt::VParameter::getValue	(	Type &	Variable,
		const RefPtr< ValuePool > &	VP,
		const string &	member
	)		const [inline]

Get the current value of the parameter.

Parameters:

VP	An eventual ValuePool storing shadow copies of the main variable.

int Wizt::VParameter::iterateUserAliases	(	UserIterator &	,
		const WeakPtr< VManagedObject > &	TheUsingObject
	)		const

Iterate over all aliases of this parameter as seen from a a specific object.

The UserIterator::apply() function will be called with the same object.

void Wizt::VParameter::notifyInputs	(	const ValuePoolPtr &	VP,
		const ValueNotifierList *	Exclude,
		const WeakPtr< ValueNotifier > &	issuer = NullPtr()
	)		const [inline]

Broadcast a value change event to all listening notifiers.

Required for VInputBase::notify().

Parameters:

Exclude

If the notify request is issued from such a notifier, then it is not broadcasted.

void Wizt::VParameter::setProperty	(	const string &	s,
		const RefPtr< VValueBase > &	V,
		const WeakPtr< ValueNotifier > &	issuer = NullPtr(),
		const ValueNotifierList *	Exclude = 0,
		const ValuePoolPtr &	Ctx = NullPtr()
	)

Set a property of this parameter, and issue a notification event relative to the global context to all listening input instances.

Note that properties are NOT context-local (which might be some TODO to change later).

void Wizt::VParameter::setSilentProperty	(	const string &	s,
		const RefPtr< VValueBase > &	V
	)		[inline]

Set a parameter's property without sending out a notification event.

A call to sendNotification() MUST be issued ASAP by the caller.

template<class Type >

bool Wizt::VParameter::setValue	(	const Type &	Variable,
		const RefPtr< ValuePool > &	VP,
		const string &	member,
		bool	forceLocalCreation,
		const WeakPtr< ValueNotifier > &	issuer,
		const ValueNotifierList *	Exclude = 0,
		const ValueMap *	vParam = 0
	)		const [inline]

Set the parameter to a certain value and inform all input listeners about this change.

Todo:

Add shadow parameterization!!

Examples:

exocoetida.cpp.

---

Member Data Documentation

int Wizt::VParameter::relevance

An optional setting to specify how relevant this parameter is for the entire scene.

This value can be used by a GUI or some logging mechanism, where it is valued against some verbosity. The relevance parameter differs from an Expert Level in that it is not necessarily related to a certain type, but rather its role in a certain session. It may be changed at any time, but it is recommended that objects defining parameters also set their relevance. The initial value is zero. It may be negative to state that the parameter is irrelevant and should not be exposed to the end-user, or positive to state its importance.

---

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

• ocean/plankton/VParameter.hpp
• ocean/plankton/VParameter.cpp