overview wiki api reference download
 All Classes Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | Protected Member Functions
gameplay::RenderState::AutoBindingResolver Class Reference

#include <RenderState.h>

List of all members.

Public Member Functions

virtual ~AutoBindingResolver ()
virtual bool resolveAutoBinding (const char *autoBinding, Node *node, MaterialParameter *parameter)=0

Protected Member Functions

 AutoBindingResolver ()

Detailed Description

An abstract base class that can be extended to support custom material auto bindings.

Implementing a custom auto binding resolver allows the set of built-in parameter auto bindings to be extended or overridden. Any parameter auto binding that is set on a material will be forwarded to any custom auto binding resolvers, in the order in which they are registered. If a registered resolver returns true (specifying that it handles the specified autoBinding), no further code will be executed for that autoBinding. This allows auto binding resolvers to not only implement new/custom binding strings, but it also lets them override existing/built-in ones. For this reason, you should ensure that you ONLY return true if you explicitly handle a custom auto binding; return false otherwise.

Note that the custom resolver is called only once for a RenderState object when its node binding is initially set. This occurs when a material is initially bound to a renderable (Model, Terrain, etc) that belongs to a Node. The resolver is NOT called each frame or each time the RenderState is bound. Therefore, when implementing custom auto bindings for values that change over time, you should bind a method pointer to the passed in MaterialParaemter using the MaterialParameter::bindValue method. This way, the bound method will be called each frame to set an updated value into the MaterialParameter.

If no registered resolvers explicitly handle an auto binding, the binding will attempt to be resolved using the internal/built-in resolver, which is able to handle any auto bindings found in the RenderState::AutoBinding enumeration.

When an instance of a class that extends AutoBindingResolver is created, it is automatically registered as a custom auto binding handler. Likewise, it is automatically deregistered on destruction.

Constructor & Destructor Documentation



Member Function Documentation

virtual bool gameplay::RenderState::AutoBindingResolver::resolveAutoBinding ( const char *  autoBinding,
Node node,
MaterialParameter parameter 
) [pure virtual]

Called when an unrecognized material auto binding is encountered during material loading.

Implemenations of this method should do a string comparison on the passed in name parameter and decide whether or not they should handle the parameter. If the parameter is not handled, false should be returned so that other auto binding resolvers get a chance to handle the parameter. Otherwise, the parameter should be set or bound and true should be returned.

autoBindingName of the auto binding to be resolved.
nodeThe node that the material is attached to.
parameterThe material parameter to be bound (if true is returned).
True if the auto binding is handled and the associated parmeter is bound, false otherwise.
 All Classes Functions Variables Typedefs Enumerations Enumerator