Base class for containers of behavior configuration. They can be attached to objects (Behavior) or layouts (BehaviorsSharedData). It stores the content (i.e: the properties) of a behavior of an object. More...

#include <BehaviorConfigurationContainer.h>

Inherited by gd::Behavior, and gd::BehaviorsSharedData.

Public Member Functions
	BehaviorConfigurationContainer (const gd::String &name_, const gd::String &type_)

virtual BehaviorConfigurationContainer *	Clone () const

const gd::String &	GetName () const
	Return the name identifying the behavior.

void	SetName (const gd::String &name_)
	Change the name identifying the behavior.

const gd::String &	GetTypeName () const
	Return the type of the behavior.

void	SetTypeName (const gd::String &type_)
	Set the type of the behavior.

std::map< gd::String, gd::PropertyDescriptor >	GetProperties () const
	Called when the IDE wants to know about the custom properties of the behavior. More...

bool	UpdateProperty (const gd::String &name, const gd::String &value)
	Called when the IDE wants to update a custom property of the behavior. More...

virtual void	InitializeContent ()
	Called to initialize the content with the default properties for the behavior.

virtual void	SerializeTo (gd::SerializerElement &element) const
	Serialize the behavior content.

virtual void	UnserializeFrom (const gd::SerializerElement &element)
	Unserialize the behavior content.

const gd::SerializerElement &	GetContent () const

gd::SerializerElement &	GetContent ()

void	SetFolded (bool fold=true)
	Set if the behavior configuration panel should be folded in the UI.

bool	IsFolded () const
	True if the behavior configuration panel should be folded in the UI.

void	SetQuickCustomizationVisibility (QuickCustomization::Visibility visibility)
	Set if the whole behavior should be visible or not in the Quick Customization.

QuickCustomization::Visibility	GetQuickCustomizationVisibility () const
	Get if the whole behavior should be visible or not in the Quick Customization.

QuickCustomizationVisibilitiesContainer &	GetPropertiesQuickCustomizationVisibilities ()
	Get the map of properties and their visibility in the Quick Customization.

const QuickCustomizationVisibilitiesContainer &	GetPropertiesQuickCustomizationVisibilities () const
	Get the map of properties and their visibility in the Quick Customization.

void	ExposeResources (gd::ArbitraryResourceWorker &worker)
	Called ( e.g. during compilation ) so as to inventory internal resources and sometimes update their filename. Implementation example: More...

Protected Member Functions
virtual std::map< gd::String, gd::PropertyDescriptor >	GetProperties (const gd::SerializerElement &behaviorContent) const
	Called when the IDE wants to know about the custom properties of the behavior. More...

virtual bool	UpdateProperty (gd::SerializerElement &behaviorContent, const gd::String &name, const gd::String &value)
	Called when the IDE wants to update a custom property of the behavior. More...

virtual void	InitializeContent (gd::SerializerElement &behaviorContent)
	Called to initialize the content with the default properties for the behavior.

Detailed Description

Base class for containers of behavior configuration. They can be attached to objects (Behavior) or layouts (BehaviorsSharedData). It stores the content (i.e: the properties) of a behavior of an object.

See also: gd::Behavior; gd::BehaviorsSharedData

Member Function Documentation

◆ ExposeResources()

void gd::BehaviorConfigurationContainer::ExposeResources ( gd::ArbitraryResourceWorker & worker )

Called ( e.g. during compilation ) so as to inventory internal resources and sometimes update their filename. Implementation example:

worker.ExposeImage(myImage);

worker.ExposeFile(myResourceFile);

See also: ArbitraryResourceWorker

◆ GetProperties() [1/2]

std::map< gd::String, gd::PropertyDescriptor > gd::BehaviorConfigurationContainer::GetProperties ( ) const

Called when the IDE wants to know about the custom properties of the behavior.

Returns: a std::map with properties names as key.

See also: gd::PropertyDescriptor

◆ GetProperties() [2/2]

std::map< gd::String, gd::PropertyDescriptor > gd::BehaviorConfigurationContainer::GetProperties ( const gd::SerializerElement & behaviorContent ) const

protectedvirtual

Called when the IDE wants to know about the custom properties of the behavior.

Implementation example:

std::map<gd::String, gd::PropertyDescriptor> properties;
properties[_("Initial speed")].SetValue(gd::String::From(initialSpeed));
 
return properties;

Returns: a std::map with properties names as key.

See also: gd::PropertyDescriptor

Reimplemented in gd::CustomBehaviorsSharedData, and gd::CustomBehavior.

◆ UpdateProperty() [1/2]

bool gd::BehaviorConfigurationContainer::UpdateProperty	(	const gd::String &	name,
		const gd::String &	value
	)

inline

Called when the IDE wants to update a custom property of the behavior.

Returns: false if the new value cannot be set

See also: gd::InitialInstance

◆ UpdateProperty() [2/2]

virtual bool gd::BehaviorConfigurationContainer::UpdateProperty	(	gd::SerializerElement &	behaviorContent,
		const gd::String &	name,
		const gd::String &	value
	)

inlineprotectedvirtual