ParameterBlendGroup Class Reference

#include <parameterblendgroup.h>

Public Member Functions
virtual	~ParameterBlendGroup ()
virtual bool	init (utility::ErrorState &errorState) override
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
std::vector< ResourcePtr< Parameter > >	mParameters
	Property: 'Parameters' list of parameters that are blended. More...
nap::ResourcePtr< ParameterGroup >	mRootGroup = nullptr
	Property: 'RootGroup' the group all blend 'Parameters' belong to, either direct or in a child group. More...
bool	mBlendAll = false
	Property: 'BlendAll' recursively traverses the specified parameter group to include all parameters in this blend group. More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)

Description

Represents a group of parameters that can be blended over time by a nap::ParameterBlendComponent. All given parameters need to be part of the root group, either as a direct sibling or contained within a group that is part of the root group.

Inheritance diagram for ParameterBlendGroup:

Collaboration diagram for ParameterBlendGroup:

Constructor & Destructor Documentation

~ParameterBlendGroup()

virtual ~ParameterBlendGroup ( )

virtual

Member Function Documentation

init()

virtual bool init ( utility::ErrorState &  errorState )

overridevirtual

Ensures that every parameter specified in the 'Parameters' property is part of the 'RootGroup'. Either as a direct sibling or contained within a group that is part of the root group.

Parameters

errorState

contains the error message when initialization fails

Returns

if initialization succeeded.

Reimplemented from Object.

Member Data Documentation

mBlendAll

bool mBlendAll = false

Property: 'BlendAll' recursively traverses the specified parameter group to include all parameters in this blend group.

mParameters

std::vector<ResourcePtr<Parameter> > mParameters

Property: 'Parameters' list of parameters that are blended.

mRootGroup

nap::ResourcePtr<ParameterGroup> mRootGroup = nullptr

Property: 'RootGroup' the group all blend 'Parameters' belong to, either direct or in a child group.