Public Member Functions

void addValue (const MemCore::WeakPtr< VValueBase > &V)
Add a value to this set.
ValueSet & operator<<= (const MemCore::WeakPtr< VValueBase > &V)
Operator overload function to add values to this set, can be written consecutively:
ValueSet ()
Empty default constructor.
ValueSet (const MemCore::WeakPtr< VValueBase > &V)
Construct a value set with a single value.
const string & ValueState () const
Return the current state of all values stored here.
~ValueSet ()
Destructor.

Related Functions

(Note that these are not member functions.)

ValueSetPair operator& (const RefPtr< ValueSet > &VS, const RefPtr< ValuePool > &VP)
The combination of a ValueSet pointer and a ValuePool forms a pair that can be assigned slots.

Detailed Description

A set of values.

Typical usage synopsis:

class   MyObject : VObject
{
        TypedSlot<int>  MyInteger;

        void proc(VRenderContext&Context) const
        {
        RefPtr<ValueSet> V = new ValueSet();
                // Add the current value of the slot MyInteger to the given ValueSet
                *V <<= MyInteger(Context);
                ...
        }
};

The ValueSet takes a VValueBase as a reference to a value and stores its current state. While the content of the VValueBase itself may change, the ValueSet knows about its former value and allows to compare it.

Examples:: ComputeMultiStreamLines.cpp.

Constructor & Destructor Documentation

Wizt::ValueSet::ValueSet ( const MemCore::WeakPtr< VValueBase > & V ) [inline]

Construct a value set with a single value.

           RefPtr<ValueSet> V = new ValueSet( MyInteger(Context) );

Member Function Documentation

ValueSet& Wizt::ValueSet::operator<<= ( const MemCore::WeakPtr< VValueBase > & V ) [inline]

Operator overload function to add values to this set, can be written consecutively:

        RefPtr<ValueSet> V = new ValueSet();
                // Add the current value of the slots MyInteger and MySecondInteger to the given ValueSet
                *V <<= MyInteger(Context) <<= MySecondInteger(Context)

Friends And Related Function Documentation

ValueSetPair operator&	(	const RefPtr< ValueSet > &	VS,
		const RefPtr< ValuePool > &	VP
	)		`[related]`

The combination of a ValueSet pointer and a ValuePool forms a pair that can be assigned slots.

RefPtr<ValueSet> Values = new ValueSet();
        // Need new textures when the slice location or orientation changes. 
        Values & Context += SliceLocation, OrientationSlot, Shift;

, ValueSetPair, VSlot

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

ocean/plankton/ValueSet.hpp
ocean/plankton/ValuePool.hpp
ocean/plankton/ValueSet.cpp