Given some VObject, this is the accompanying Creator object that may be used to create VObject's on request. More...

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

Public Types

enum { CreationPriority = 0 }

Public Member Functions

override VAcceptInfoList_t accept (const RefPtr< VObject > &vobj) const
Implementation of the acception function.
override RefPtr< VObject > create (const string &s, const Intercube &CreationContext) const
Actually create the associated VObject on request from the base class.
override string createChildname (const string &parent_name) const
Implementation of the child name creation functionality.
VCreator (const string &name, int quality, const RefPtr< VCreationPreferences > &prop=NullPtr())
VCreator (const VCreatorPropertyBase &CreatorProperties, int quality, const RefPtr< VCreationPreferences > &prop=NullPtr())
Construct a creator object with full properties specified.
template<unsigned ID> VCreator (const VCreatorProperty< ID > &CreatorProperties, int quality, const RefPtr< VCreationPreferences > &prop=NullPtr())
Construct a creator object with full properties specified.

Related Functions

(Note that these are not member functions.)

template<unsigned ID1, unsigned ID2> VCreatorProperty< ID1+ID2 > operator+ (const VCreatorProperty< ID1 > &l, const VCreatorProperty< ID2 > &r)
Merge two properties via the + operator.
template<unsigned ID1, unsigned ID2> VCreatorProperty< ID1+ID2 > operator/ (const VCreatorProperty< ID1 > &l, const VCreatorProperty< ID2 > &r)
Merge two properties via the / operator, same as using the + operator (just another syntax).

Detailed Description

Given some VObject, this is the accompanying Creator object that may be used to create VObject's on request.

The VObject must provide a constructor taking the new object's name and its priority number, which is forwarded from the creator's priority.

VCreator objects come with a property that tells whether the object it might create is suitable as output for a certain, existing VObject. A such, the existing VObject is to be checked for its properties to see if this VCreator is suitable for bearing a child object. This check is done through the virtual accept() member function. A specific VCreator may always overload this function to implement any operation.

The default VCreator utilizes a list of properties managed through the AcceptListIterator<> template. This one allows to specify a list of types. If any of these types is managed in the existing VObject, then the accept() function will return true. It is an OR of all properties.

The AcceptListIterator may also be used to implement operations on user defined types. For this, it needs to be specialized for a certain type and implement an accept() function such as in this following code snippet:

struct  MyInspector
{};

namespace Wizt
{

template <>
class AcceptListIterator<MyInspector>
{
public:
static  override RefPtr<VAcceptInfo> accept(const RefPtr<VObject>&vobj)
        {
                puts("AcceptListIterator<SurfaceInspector>");

                if (!vobj)
                        return NullPtr(); 

                if (vobj->implements( typeid(Fiber::BundlePtr) ) )
                {
//                      Vprintf(6, "    AcceptListIterator: yep, accepted!\n" ); 
//                      printf("    AcceptListIterator: yep, accepted!\n" ); 
                        return new VAcceptInfo( typeid(Fiber::BundlePtr) );
                } 

                return NullPtr();
        }
};

}

static VCreator<MyObject, AcceptList<MyInspector> >::global MyObjectCreator;

The accept() function may of course be arbitrarily complex. By default, there are accept list iterators implemented for native types (which are provided via output parameters of VObjects), and interfaces, that are attached to VObjects.

See also:: Panthalassa syntax for improved object construction.

Examples:: DemoSphere.cpp, exocoetida.cpp, MultiplyInt.cpp, PointSprite.cpp, and stockvish.cpp.

Constructor & Destructor Documentation

Wizt::VCreator::VCreator	(	const VCreatorPropertyBase &	CreatorProperties,
		int	quality,
		const RefPtr< VCreationPreferences > &	prop = `NullPtr()`
	)		`[inline]`

Construct a creator object with full properties specified.

Parameters:

CreatorProperties	The properties of this creator, it is recommendable to make use of namespace Panthalassia or ProtoOcean.
quality	The object's matureness, according to ObjectQuality

template<unsigned ID>

Wizt::VCreator::VCreator	(	const VCreatorProperty< ID > &	CreatorProperties,
		int	quality,
		const RefPtr< VCreationPreferences > &	prop = `NullPtr()`
	)		`[inline]`

Construct a creator object with full properties specified.

Parameters:

CreatorProperties	The properties of this creator, it is recommendable to make use of namespace Panthalassia or ProtoOcean.
quality	The object's matureness, according to ObjectQuality

Allows to create objects via Panthalassia syntax:

           using namespace Panthalassa;

           static Ref<VCreator<myObject> >
                   MyCreator(
                                Category("Display")
                                + Identifier("ScalarValues")
                                + Help("Display the values of a scalar field at the location of each vertex")
                                , ObjectQuality::MATURE);

Member Function Documentation

override VAcceptInfoList_t Wizt::VCreator::accept ( const RefPtr< VObject > & vobj ) const [inline, virtual]

Implementation of the acception function.

Calls the static accept() function of the DerivedVObject.

Implements Wizt::VCreatorBase.

override RefPtr<VObject> Wizt::VCreator::create	(	const string &	s,
		const Intercube &	CreationContext
	)		const `[inline, virtual]`

Actually create the associated VObject on request from the base class.

Parameters:

CreationContext An Intercube that allows specifying additional parameters for the circumstances of creation. It is passed to the VActionNotifier::VObjectCreation() call.

Note:: The VCreator object must be refcounted already since a strong pointer is used internally here when passing the creator object to all VActionNotifiers.

Implements Wizt::VCreatorBase.

override string Wizt::VCreator::createChildname ( const string & parent_name ) const [inline, virtual]

Implementation of the child name creation functionality.

By default, calls a static member function of the derived object on which this VCreator is instantiated.

Reimplemented from Wizt::VCreatorBase.

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

ocean/plankton/VCreator.hpp
ocean/plankton/VCreatorProperties.hpp