This is a masked object resource. More...

Inheritance diagram for MaskedObject:

Public Member Functions
	MaskedObject ()
	Creates a new empty masked object. More...

	MaskedObject (Graphics::MaskedBitmapAnimationProvider &&prov)
	Creates a new masked object using another masked object provider. More...

	MaskedObject (Graphics::MaskedBitmapAnimationProvider &prov)
	Creates a new masked object using another masked object provider. More...

	MaskedObject (Graphics::MaskedBitmapProvider &&prov)
	Creates a new masked object using another masked object provider. More...

	MaskedObject (Graphics::MaskedBitmapProvider &prov)
	Creates a new masked object using another masked object provider. More...

	MaskedObject (Graphics::MaskedObjectProvider &&prov)
	Creates a new masked object using another masked object provider. More...

	MaskedObject (Graphics::MaskedObjectProvider &prov)
	Creates a new masked object using another masked object provider. More...

void	AssumeProvider (Graphics::MaskedBitmapAnimationProvider &value)
	Changes the provider stored in this masked object, ownership will be transferred. More...

void	AssumeProvider (Graphics::MaskedBitmapProvider &value)
	Changes the provider stored in this masked object, ownership will be transferred. More...

void	AssumeProvider (Graphics::MaskedObjectProvider &value)
	Changes the provider stored in this masked object, ownership will be transferred. More...

virtual Graphics::MaskedObject &	CreateAnimation (bool create=true) const override
	This function should create and animation and depending on the create parameter, it should create its own timer. More...

virtual Graphics::MaskedObject &	CreateAnimation (Gorgon::Animation::ControllerBase &timer) const override
	This function should create a new animation with the given controller and if owner parameter is set to true, it should assume ownership of the controller. More...

virtual Graphics::RectangularAnimation &	CreateBase () const override

virtual Graphics::RectangularAnimation &	CreateMask () const override

GID::Type	GetGID () const override
	This function shall return Gorgon ID of this resource. More...

virtual Geometry::Size	GetSize () const override

IMaskedObjectProvider &	MoveOutProvider () override
	This function moves this animation provider into a new provider. More...

void	RemoveProvider ()
	Removes the provider, if it is own by this resource it will be deleted. More...

void	SetProvider (Graphics::MaskedBitmapAnimationProvider &value)
	Changes the provider stored in this masked object, ownership will not be transferred. More...

void	SetProvider (Graphics::MaskedBitmapProvider &value)
	Changes the provider stored in this masked object, ownership will not be transferred. More...

void	SetProvider (Graphics::MaskedObjectProvider &value)
	Changes the provider stored in this masked object, ownership will not be transferred. More...

Public Member Functions inherited from RectangularAnimationProvider
int	GetHeight () const

int	GetWidth () const

Public Member Functions inherited from AnimationProvider
virtual	~AnimationProvider ()

Public Member Functions inherited from Provider
virtual	~Provider ()
	Virtual destructor. More...

Public Member Functions inherited from AnimationStorage
Graphics::RectangularAnimationStorage	MoveOut ()
	Moves this animation out as a generic value type animation. More...

Public Member Functions inherited from Base
	Base ()
	Default constructor. More...

const Containers::Collection< Base >::ConstIterator	begin () const
	Allows easy iteration through range based fors. More...

const Containers::Collection< Base >::ConstIterator	cbegin () const
	Beginning of children. More...

const Containers::Collection< Base >::ConstIterator	cend () const
	End of children. More...

bool	DeleteResource ()
	Safely deletes the resource. More...

virtual void	Discard ()
	This function shall discard any transitional data which is not vital after Prepare function is issued. More...

const Containers::Collection< Base >::ConstIterator	end () const
	Allows easy iteration through range based fors. More...

virtual SGuid	GetGuid () const
	Returns the guid of the object. More...

const std::string &	GetName () const
	Returns the name of this object. More...

Base &	GetParent () const
	Returns the parent. If no parent set, this function throws std::runtime_error. More...

Base *	GetParentPtr () const
	Returns the pointer to the parent. This function may return nullptr. More...

const Base &	GetRoot () const
	Returns the root of this resource. More...

bool	HasParent () const
	Returns whether this object has a parent. More...

virtual bool	IsEqual (const SGuid &guid) const
	This function tests whether this object has the given SGuid. More...

virtual void	Prepare ()
	This function shall prepare this resource to be used after resource is loaded. More...

virtual void	Resolve (File &file)
	This function shall resolve links or similar constructs. More...

void	Save (Writer &writer)
	Saves this object into the given writer. The writer should be open prior to this call. More...

virtual void	SetGuid (SGuid guid)
	Changes the guid of the object. More...

virtual void	SetName (const std::string &name)
	Sets the name of the object. More...

Static Public Member Functions
static MaskedObject *	LoadResource (std::weak_ptr< File > file, std::shared_ptr< Reader > reader, unsigned long size)
	This function loads a masked object resource from the file. More...

static void	SaveThis (Writer &writer, const Graphics::IMaskedObjectProvider &provider)

Protected Member Functions
virtual Graphics::RectangularAnimationStorage	animmoveout () override

void	save (Writer &writer) const override

Protected Member Functions inherited from Base
virtual	~Base ()
	Destructor, Always children gets destroyed first. More...

void	destroychildren ()
	Destroys the children of this resource. More...

void	setparenttonullptr (Base &base)
	Sets the parent of an object to nullptr, provides access. More...

Additional Inherited Members
Public Types inherited from RectangularAnimationProvider
using	AnimationType = RectangularAnimation

Public Types inherited from AnimationProvider
using	AnimationType = Animation

Public Types inherited from Provider
using	AnimationType = Base

Public Attributes inherited from Base
const Containers::Collection< Base > &	Children
	The children this object have. More...

unsigned long	refcount
	INTERNAL, Reference count, used in linking mechanism. More...

Protected Attributes inherited from Base
Containers::Collection< Base >	children
	Child objects that this resource object have. More...

SGuid	guid
	SGuid to identify this resource object. More...

std::string	name
	Name of this resource object, may not be loaded. More...

Base *	parent
	Immediate parent of this resource. More...

const Base *	root
	Root of this resource. More...

Detailed Description

This is a masked object resource.

It stores a Graphics::MaskedObjectProvider or compatible types: Graphics::MaskedBitmapProvider and Graphics::MaskedBitmapAnimationProvider.