Provides a generic interface for attributes and their values and the possibility to serialize them. More...

#include <duckcpp/core/engine/IAttributes.hpp>

Inheritance diagram for dcpp::io::IAttributes:

Collaboration diagram for dcpp::io::IAttributes:

Public Member Functions
virtual u32	getAttributeCount () const =0
	Returns amount of attributes in this collection of attributes.

virtual const c8 *	getAttributeName (i32 index) const =0

virtual E_ATTRIBUTE_TYPE	getAttributeType (const c8 *attributeName) const =0

virtual E_ATTRIBUTE_TYPE	getAttributeType (i32 index) const =0

virtual const wchar_t *	getAttributeTypeString (const c8 attributeName, const wchar_t defaultNotFound=L"unknown") const =0

virtual const wchar_t *	getAttributeTypeString (i32 index, const wchar_t *defaultNotFound=L"unknown") const =0

virtual bool	existsAttribute (const c8 *attributeName) const =0
	Returns if an attribute with a name exists.

virtual i32	findAttribute (const c8 *attributeName) const =0
	Returns attribute index from name, -1 if not found.

virtual void	clear ()=0
	Removes all attributes.

virtual bool	read (io::IXMLReader reader, bool readCurrentElementOnly=false, const wchar_t elementName=0)=0

virtual bool	write (io::IXMLWriter writer, bool writeXMLHeader=false, const wchar_t elementName=0)=0

virtual void	addInt (const c8 *attributeName, i32 value)=0
	Adds an attribute as integer.

virtual void	setAttribute (const c8 *attributeName, i32 value)=0
	Sets an attribute as integer value.

virtual i32	getAttributeAsInt (const c8 *attributeName, dcpp::i32 defaultNotFound=0) const =0

virtual i32	getAttributeAsInt (i32 index) const =0

virtual void	setAttribute (i32 index, i32 value)=0
	Sets an attribute as integer value.

virtual void	addFloat (const c8 *attributeName, f32 value)=0
	Adds an attribute as float.

virtual void	setAttribute (const c8 *attributeName, f32 value)=0
	Sets a attribute as float value.

virtual f32	getAttributeAsFloat (const c8 *attributeName, dcpp::f32 defaultNotFound=0.f) const =0

virtual f32	getAttributeAsFloat (i32 index) const =0

virtual void	setAttribute (i32 index, f32 value)=0
	Sets an attribute as float value.

virtual void	addString (const c8 attributeName, const c8 value)=0
	Adds an attribute as string.

virtual void	setAttribute (const c8 attributeName, const c8 value)=0

virtual dcpp::nub::string	getAttributeAsString (const c8 *attributeName, const dcpp::nub::string &defaultNotFound=dcpp::nub::string()) const =0

virtual void	getAttributeAsString (const c8 attributeName, c8 target) const =0

virtual dcpp::nub::string	getAttributeAsString (i32 index) const =0

virtual void	setAttribute (i32 index, const c8 *value)=0

virtual void	addString (const c8 attributeName, const wchar_t value)=0
	Adds an attribute as string.

virtual void	setAttribute (const c8 attributeName, const wchar_t value)=0

virtual nub::wstring	getAttributeAsWstring (const c8 *attributeName, const nub::wstring &defaultNotFound=nub::wstring()) const =0

virtual void	getAttributeAsWstring (const c8 attributeName, wchar_t target) const =0

virtual nub::wstring	getAttributeAsWstring (i32 index) const =0

virtual void	setAttribute (i32 index, const wchar_t *value)=0

virtual void	addBinary (const c8 attributeName, void data, i32 dataSizeInBytes)=0
	Adds an attribute as binary data.

virtual void	setAttribute (const c8 attributeName, void data, i32 dataSizeInBytes)=0
	Sets an attribute as binary data.

virtual void	getAttributeAsBinaryData (const c8 attributeName, void outData, i32 maxSizeInBytes) const =0
	Gets an attribute as binary data.

virtual void	getAttributeAsBinaryData (i32 index, void *outData, i32 maxSizeInBytes) const =0
	Gets an attribute as binary data.

virtual void	setAttribute (i32 index, void *data, i32 dataSizeInBytes)=0
	Sets an attribute as binary data.

virtual void	addArray (const c8 *attributeName, const nub::array< nub::wstring > &value)=0
	Adds an attribute as wide string array.

virtual void	setAttribute (const c8 *attributeName, const nub::array< nub::wstring > &value)=0

virtual nub::array< nub::wstring >	getAttributeAsArray (const c8 *attributeName, const nub::array< nub::wstring > &defaultNotFound=nub::array< nub::wstring >()) const =0

virtual nub::array< nub::wstring >	getAttributeAsArray (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::array< nub::wstring > &value)=0
	Sets an attribute as an array of wide strings.

virtual void	addBool (const c8 *attributeName, bool value)=0
	Adds an attribute as bool.

virtual void	setAttribute (const c8 *attributeName, bool value)=0
	Sets an attribute as boolean value.

virtual bool	getAttributeAsBool (const c8 *attributeName, bool defaultNotFound=false) const =0

virtual bool	getAttributeAsBool (i32 index) const =0

virtual void	setAttribute (i32 index, bool value)=0
	Sets an attribute as boolean value.

virtual void	addEnum (const c8 attributeName, const c8 enumValue, const c8 const enumerationLiterals)=0
	Adds an attribute as enum.

virtual void	addEnum (const c8 attributeName, i32 enumValue, const c8 const *enumerationLiterals)=0
	Adds an attribute as enum.

virtual void	setAttribute (const c8 attributeName, const c8 enumValue, const c8 const enumerationLiterals)=0
	Sets an attribute as enumeration.

virtual const c8 *	getAttributeAsEnumeration (const c8 attributeName, const c8 defaultNotFound=0) const =0

virtual i32	getAttributeAsEnumeration (const c8 attributeName, const c8 const *enumerationLiteralsToUse, i32 defaultNotFound=-1) const =0
	Gets an attribute as enumeration.

virtual i32	getAttributeAsEnumeration (i32 index, const c8 const enumerationLiteralsToUse, i32 defaultNotFound=-1) const =0
	Gets an attribute as enumeration.

virtual const c8 *	getAttributeAsEnumeration (i32 index) const =0

virtual void	getAttributeEnumerationLiteralsOfEnumeration (const c8 *attributeName, nub::array< dcpp::nub::string > &outLiterals) const =0

virtual void	getAttributeEnumerationLiteralsOfEnumeration (i32 index, nub::array< dcpp::nub::string > &outLiterals) const =0

virtual void	setAttribute (i32 index, const c8 enumValue, const c8 const *enumerationLiterals)=0
	Sets an attribute as enumeration.

virtual void	addColor (const c8 *attributeName, video::SColor value)=0
	Adds an attribute as color.

virtual void	setAttribute (const c8 *attributeName, video::SColor color)=0
	Sets a attribute as color.

virtual video::SColor	getAttributeAsColor (const c8 *attributeName, const video::SColor &defaultNotFound=video::SColor(0)) const =0

virtual video::SColor	getAttributeAsColor (i32 index) const =0

virtual void	setAttribute (i32 index, video::SColor color)=0
	Sets an attribute as color.

virtual void	addColorf (const c8 *attributeName, video::SColorf value)=0
	Adds an attribute as floating point color.

virtual void	setAttribute (const c8 *attributeName, video::SColorf color)=0
	Sets a attribute as floating point color.

virtual video::SColorf	getAttributeAsColorf (const c8 *attributeName, const video::SColorf &defaultNotFound=video::SColorf(0)) const =0

virtual video::SColorf	getAttributeAsColorf (i32 index) const =0

virtual void	setAttribute (i32 index, video::SColorf color)=0
	Sets an attribute as floating point color.

virtual void	addVector3d (const c8 *attributeName, const nub::vector3df &value)=0
	Adds an attribute as 3d vector.

virtual void	setAttribute (const c8 *attributeName, const nub::vector3df &v)=0
	Sets a attribute as 3d vector.

virtual nub::vector3df	getAttributeAsVector3d (const c8 *attributeName, const nub::vector3df &defaultNotFound=nub::vector3df(0, 0, 0)) const =0

virtual nub::vector3df	getAttributeAsVector3d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::vector3df &v)=0
	Sets an attribute as vector.

virtual void	addVector2d (const c8 *attributeName, const nub::vector2df &value)=0
	Adds an attribute as 2d vector.

virtual void	setAttribute (const c8 *attributeName, const nub::vector2df &v)=0
	Sets a attribute as 2d vector.

virtual nub::vector2df	getAttributeAsVector2d (const c8 *attributeName, const nub::vector2df &defaultNotFound=nub::vector2df(0, 0)) const =0

virtual nub::vector2df	getAttributeAsVector2d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::vector2df &v)=0
	Sets an attribute as 2d vector.

virtual void	addPosition2d (const c8 *attributeName, const nub::position2di &value)=0
	Adds an attribute as 2d position.

virtual void	setAttribute (const c8 *attributeName, const nub::position2di &v)=0
	Sets a attribute as 2d position.

virtual nub::position2di	getAttributeAsPosition2d (const c8 *attributeName, const nub::position2di &defaultNotFound=nub::position2di(0, 0)) const =0

virtual nub::position2di	getAttributeAsPosition2d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::position2di &v)=0
	Sets an attribute as 2d position.

virtual void	addRect (const c8 *attributeName, const nub::rect< i32 > &value)=0
	Adds an attribute as rectangle.

virtual void	setAttribute (const c8 *attributeName, const nub::rect< i32 > &v)=0
	Sets an attribute as rectangle.

virtual nub::rect< i32 >	getAttributeAsRect (const c8 *attributeName, const nub::rect< i32 > &defaultNotFound=nub::rect< i32 >()) const =0

virtual nub::rect< i32 >	getAttributeAsRect (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::rect< i32 > &v)=0
	Sets an attribute as rectangle.

virtual void	addDimension2d (const c8 *attributeName, const nub::dimension2d< u32 > &value)=0
	Adds an attribute as dimension2d.

virtual void	setAttribute (const c8 *attributeName, const nub::dimension2d< u32 > &v)=0
	Sets an attribute as dimension2d.

virtual nub::dimension2d< u32 >	getAttributeAsDimension2d (const c8 *attributeName, const nub::dimension2d< u32 > &defaultNotFound=nub::dimension2d< u32 >()) const =0

virtual nub::dimension2d< u32 >	getAttributeAsDimension2d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::dimension2d< u32 > &v)=0
	Sets an attribute as dimension2d.

virtual void	addMatrix (const c8 *attributeName, const nub::matrix4 &v)=0
	Adds an attribute as matrix.

virtual void	setAttribute (const c8 *attributeName, const nub::matrix4 &v)=0
	Sets an attribute as matrix.

virtual nub::matrix4	getAttributeAsMatrix (const c8 *attributeName, const nub::matrix4 &defaultNotFound=nub::matrix4()) const =0

virtual nub::matrix4	getAttributeAsMatrix (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::matrix4 &v)=0
	Sets an attribute as matrix.

virtual void	addQuaternion (const c8 *attributeName, const nub::quaternion &v)=0
	Adds an attribute as quaternion.

virtual void	setAttribute (const c8 *attributeName, const nub::quaternion &v)=0
	Sets an attribute as quaternion.

virtual nub::quaternion	getAttributeAsQuaternion (const c8 *attributeName, const nub::quaternion &defaultNotFound=nub::quaternion(0, 1, 0, 0)) const =0

virtual nub::quaternion	getAttributeAsQuaternion (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::quaternion &v)=0
	Sets an attribute as quaternion.

virtual void	addBox3d (const c8 *attributeName, const nub::aabbox3df &v)=0
	Adds an attribute as axis aligned bounding box.

virtual void	setAttribute (const c8 *attributeName, const nub::aabbox3df &v)=0
	Sets an attribute as axis aligned bounding box.

virtual nub::aabbox3df	getAttributeAsBox3d (const c8 *attributeName, const nub::aabbox3df &defaultNotFound=nub::aabbox3df(0, 0, 0, 0, 0, 0)) const =0

virtual nub::aabbox3df	getAttributeAsBox3d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::aabbox3df &v)=0
	Sets an attribute as axis aligned bounding box.

virtual void	addPlane3d (const c8 *attributeName, const nub::plane3df &v)=0
	Adds an attribute as 3d plane.

virtual void	setAttribute (const c8 *attributeName, const nub::plane3df &v)=0
	Sets an attribute as 3d plane.

virtual nub::plane3df	getAttributeAsPlane3d (const c8 *attributeName, const nub::plane3df &defaultNotFound=nub::plane3df(0, 0, 0, 0, 1, 0)) const =0

virtual nub::plane3df	getAttributeAsPlane3d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::plane3df &v)=0
	Sets an attribute as 3d plane.

virtual void	addTriangle3d (const c8 *attributeName, const nub::triangle3df &v)=0
	Adds an attribute as 3d triangle.

virtual void	setAttribute (const c8 *attributeName, const nub::triangle3df &v)=0
	Sets an attribute as 3d trianle.

virtual nub::triangle3df	getAttributeAsTriangle3d (const c8 *attributeName, const nub::triangle3df &defaultNotFound=nub::triangle3df(nub::vector3df(0, 0, 0), nub::vector3df(0, 0, 0), nub::vector3df(0, 0, 0))) const =0

virtual nub::triangle3df	getAttributeAsTriangle3d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::triangle3df &v)=0
	Sets an attribute as 3d triangle.

virtual void	addLine2d (const c8 *attributeName, const nub::line2df &v)=0
	Adds an attribute as a 2d line.

virtual void	setAttribute (const c8 *attributeName, const nub::line2df &v)=0
	Sets an attribute as a 2d line.

virtual nub::line2df	getAttributeAsLine2d (const c8 *attributeName, const nub::line2df &defaultNotFound=nub::line2df(0, 0, 0, 0)) const =0

virtual nub::line2df	getAttributeAsLine2d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::line2df &v)=0
	Sets an attribute as a 2d line.

virtual void	addLine3d (const c8 *attributeName, const nub::line3df &v)=0
	Adds an attribute as a 3d line.

virtual void	setAttribute (const c8 *attributeName, const nub::line3df &v)=0
	Sets an attribute as a 3d line.

virtual nub::line3df	getAttributeAsLine3d (const c8 *attributeName, const nub::line3df &defaultNotFound=nub::line3df(0, 0, 0, 0, 0, 0)) const =0

virtual nub::line3df	getAttributeAsLine3d (i32 index) const =0

virtual void	setAttribute (i32 index, const nub::line3df &v)=0
	Sets an attribute as a 3d line.

virtual void	addTexture (const c8 attributeName, video::ITexture texture, const io::path &filename="")=0
	Adds an attribute as texture reference.

virtual void	setAttribute (const c8 attributeName, video::ITexture texture, const io::path &filename="")=0
	Sets an attribute as texture reference.

virtual video::ITexture *	getAttributeAsTexture (const c8 attributeName, video::ITexture defaultNotFound=0) const =0

virtual video::ITexture *	getAttributeAsTexture (i32 index) const =0

virtual void	setAttribute (i32 index, video::ITexture *texture, const io::path &filename="")=0
	Sets an attribute as texture reference.

virtual void	addUserPointer (const c8 attributeName, void userPointer)=0
	Adds an attribute as user pointer.

virtual void	setAttribute (const c8 attributeName, void userPointer)=0
	Sets an attribute as user pointer.

virtual void *	getAttributeAsUserPointer (const c8 attributeName, void defaultNotFound=0) const =0

virtual void *	getAttributeAsUserPointer (i32 index) const =0

virtual void	setAttribute (i32 index, void *userPointer)=0
	Sets an attribute as user pointer.

Public Member Functions inherited from dcpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

i32	getReferenceCount () const
	Get the reference count.

const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from dcpp::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

Provides a generic interface for attributes and their values and the possibility to serialize them.

Member Function Documentation

◆ getAttributeAsArray() [1/2]

virtual nub::array< nub::wstring > dcpp::io::IAttributes::getAttributeAsArray	(	const c8 *	attributeName,
		const nub::array< nub::wstring > &	defaultNotFound = `nub::array< nub::wstring >()`
	)		const

pure virtual

Gets an attribute as an array of wide strings.

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute() or defaultNotFound if attribute is not set.

◆ getAttributeAsArray() [2/2]

virtual nub::array< nub::wstring > dcpp::io::IAttributes::getAttributeAsArray ( i32 index ) const

pure virtual

Returns attribute value as an array of wide strings by index.

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsBinaryData() [1/2]

virtual void dcpp::io::IAttributes::getAttributeAsBinaryData	(	const c8 *	attributeName,
		void *	outData,
		i32	maxSizeInBytes
	)		const

pure virtual

Gets an attribute as binary data.

Parameters

attributeName	Name of the attribute to get.
outData	Pointer to buffer where data shall be stored.
maxSizeInBytes	Maximum number of bytes to write into outData.

◆ getAttributeAsBinaryData() [2/2]

virtual void dcpp::io::IAttributes::getAttributeAsBinaryData	(	i32	index,
		void *	outData,
		i32	maxSizeInBytes
	)		const

pure virtual

Gets an attribute as binary data.

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
outData	Pointer to buffer where data shall be stored.
maxSizeInBytes	Maximum number of bytes to write into outData.

◆ getAttributeAsBool() [1/2]

virtual bool dcpp::io::IAttributes::getAttributeAsBool	(	const c8 *	attributeName,
		bool	defaultNotFound = `false`
	)		const

pure virtual

Gets an attribute as boolean value

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsBool() [2/2]

virtual bool dcpp::io::IAttributes::getAttributeAsBool ( i32 index ) const

pure virtual

Gets an attribute as boolean value

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsBox3d() [1/2]

virtual nub::aabbox3df dcpp::io::IAttributes::getAttributeAsBox3d	(	const c8 *	attributeName,
		const nub::aabbox3df &	defaultNotFound = `nub::aabbox3df(0, 0, 0, 0, 0, 0)`
	)		const

pure virtual

Gets an attribute as a axis aligned bounding box

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsBox3d() [2/2]

virtual nub::aabbox3df dcpp::io::IAttributes::getAttributeAsBox3d ( i32 index ) const

pure virtual

Gets an attribute as axis aligned bounding box

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsColor() [1/2]

virtual video::SColor dcpp::io::IAttributes::getAttributeAsColor	(	const c8 *	attributeName,
		const video::SColor &	defaultNotFound = `video::SColor(0)`
	)		const

pure virtual

Gets an attribute as color

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsColor() [2/2]

virtual video::SColor dcpp::io::IAttributes::getAttributeAsColor ( i32 index ) const

pure virtual

Gets an attribute as color

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsColorf() [1/2]

virtual video::SColorf dcpp::io::IAttributes::getAttributeAsColorf	(	const c8 *	attributeName,
		const video::SColorf &	defaultNotFound = `video::SColorf(0)`
	)		const

pure virtual

Gets an attribute as floating point color

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsColorf() [2/2]

virtual video::SColorf dcpp::io::IAttributes::getAttributeAsColorf ( i32 index ) const

pure virtual

Gets an attribute as floating point color

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsDimension2d() [1/2]

virtual nub::dimension2d< u32 > dcpp::io::IAttributes::getAttributeAsDimension2d	(	const c8 *	attributeName,
		const nub::dimension2d< u32 > &	defaultNotFound = `nub::dimension2d< u32 >()`
	)		const

pure virtual

Gets an attribute as dimension2d

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsDimension2d() [2/2]

virtual nub::dimension2d< u32 > dcpp::io::IAttributes::getAttributeAsDimension2d ( i32 index ) const

pure virtual

Gets an attribute as dimension2d

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsEnumeration() [1/4]

virtual i32 dcpp::io::IAttributes::getAttributeAsEnumeration	(	const c8 *	attributeName,
		const c8 const	enumerationLiteralsToUse,
		i32	defaultNotFound = `-1`
	)		const

pure virtual

Gets an attribute as enumeration.

Parameters

attributeName	Name of the attribute to get.
enumerationLiteralsToUse	Use these enumeration literals to get the index value instead of the set ones. This is useful when the attribute list maybe was read from an xml file, and only contains the enumeration string, but no information about its index.

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsEnumeration() [2/4]

virtual const c8 * dcpp::io::IAttributes::getAttributeAsEnumeration	(	const c8 *	attributeName,
		const c8 *	defaultNotFound = `0`
	)		const

pure virtual

Gets an attribute as enumeration

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsEnumeration() [3/4]

virtual const c8 * dcpp::io::IAttributes::getAttributeAsEnumeration ( i32 index ) const

pure virtual

Gets an attribute as enumeration

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsEnumeration() [4/4]

virtual i32 dcpp::io::IAttributes::getAttributeAsEnumeration	(	i32	index,
		const c8 const	enumerationLiteralsToUse,
		i32	defaultNotFound = `-1`
	)		const

pure virtual

Gets an attribute as enumeration.

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
enumerationLiteralsToUse	Use these enumeration literals to get the index value instead of the set ones. This is useful when the attribute list maybe was read from an xml file, and only contains the enumeration string, but no information about its index.
defaultNotFound	Value returned when the attribute referenced by the index was not found.

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsFloat() [1/2]

virtual f32 dcpp::io::IAttributes::getAttributeAsFloat	(	const c8 *	attributeName,
		dcpp::f32	defaultNotFound = `0.f`
	)		const

pure virtual

Gets an attribute as float value

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsFloat() [2/2]

virtual f32 dcpp::io::IAttributes::getAttributeAsFloat ( i32 index ) const

pure virtual

Gets an attribute as float value

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsInt() [1/2]

virtual i32 dcpp::io::IAttributes::getAttributeAsInt	(	const c8 *	attributeName,
		dcpp::i32	defaultNotFound = `0`
	)		const

pure virtual

Gets an attribute as integer value

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsInt() [2/2]

virtual i32 dcpp::io::IAttributes::getAttributeAsInt ( i32 index ) const

pure virtual

Gets an attribute as integer value

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsLine2d() [1/2]

virtual nub::line2df dcpp::io::IAttributes::getAttributeAsLine2d	(	const c8 *	attributeName,
		const nub::line2df &	defaultNotFound = `nub::line2df(0, 0, 0, 0)`
	)		const

pure virtual

Gets an attribute as a 2d line

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsLine2d() [2/2]

virtual nub::line2df dcpp::io::IAttributes::getAttributeAsLine2d ( i32 index ) const

pure virtual

Gets an attribute as a 2d line

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsLine3d() [1/2]

virtual nub::line3df dcpp::io::IAttributes::getAttributeAsLine3d	(	const c8 *	attributeName,
		const nub::line3df &	defaultNotFound = `nub::line3df(0, 0, 0, 0, 0, 0)`
	)		const

pure virtual

Gets an attribute as a 3d line

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsLine3d() [2/2]

virtual nub::line3df dcpp::io::IAttributes::getAttributeAsLine3d ( i32 index ) const

pure virtual

Gets an attribute as a 3d line

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsMatrix() [1/2]

virtual nub::matrix4 dcpp::io::IAttributes::getAttributeAsMatrix	(	const c8 *	attributeName,
		const nub::matrix4 &	defaultNotFound = `nub::matrix4()`
	)		const

pure virtual

Gets an attribute as a matrix4

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsMatrix() [2/2]

virtual nub::matrix4 dcpp::io::IAttributes::getAttributeAsMatrix ( i32 index ) const

pure virtual

Gets an attribute as matrix

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsPlane3d() [1/2]

virtual nub::plane3df dcpp::io::IAttributes::getAttributeAsPlane3d	(	const c8 *	attributeName,
		const nub::plane3df &	defaultNotFound = `nub::plane3df(0, 0, 0, 0, 1, 0)`
	)		const

pure virtual

Gets an attribute as a 3d plane

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsPlane3d() [2/2]

virtual nub::plane3df dcpp::io::IAttributes::getAttributeAsPlane3d ( i32 index ) const

pure virtual

Gets an attribute as 3d plane

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsPosition2d() [1/2]

virtual nub::position2di dcpp::io::IAttributes::getAttributeAsPosition2d	(	const c8 *	attributeName,
		const nub::position2di &	defaultNotFound = `nub::position2di(0, 0)`
	)		const

pure virtual

Gets an attribute as position

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsPosition2d() [2/2]

virtual nub::position2di dcpp::io::IAttributes::getAttributeAsPosition2d ( i32 index ) const

pure virtual

Gets an attribute as position

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsQuaternion() [1/2]

virtual nub::quaternion dcpp::io::IAttributes::getAttributeAsQuaternion	(	const c8 *	attributeName,
		const nub::quaternion &	defaultNotFound = `nub::quaternion(0, 1, 0, 0)`
	)		const

pure virtual

Gets an attribute as a quaternion

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsQuaternion() [2/2]

virtual nub::quaternion dcpp::io::IAttributes::getAttributeAsQuaternion ( i32 index ) const

pure virtual

Gets an attribute as quaternion

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsRect() [1/2]

virtual nub::rect< i32 > dcpp::io::IAttributes::getAttributeAsRect	(	const c8 *	attributeName,
		const nub::rect< i32 > &	defaultNotFound = `nub::rect< i32 >()`
	)		const

pure virtual

Gets an attribute as rectangle

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsRect() [2/2]

virtual nub::rect< i32 > dcpp::io::IAttributes::getAttributeAsRect ( i32 index ) const

pure virtual

Gets an attribute as rectangle

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsString() [1/3]

virtual void dcpp::io::IAttributes::getAttributeAsString	(	const c8 *	attributeName,
		c8 *	target
	)		const

pure virtual

Gets an attribute as string.

Parameters

attributeName	Name of the attribute to get.
target	Buffer where the string is copied to.

◆ getAttributeAsString() [2/3]

virtual dcpp::nub::string dcpp::io::IAttributes::getAttributeAsString	(	const c8 *	attributeName,
		const dcpp::nub::string &	defaultNotFound = `dcpp::nub::string()`
	)		const

pure virtual

Gets an attribute as string.

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute() or defaultNotFound if attribute is not set.

◆ getAttributeAsString() [3/3]

virtual dcpp::nub::string dcpp::io::IAttributes::getAttributeAsString ( i32 index ) const

pure virtual

Returns attribute value as string by index.

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsTexture() [1/2]

virtual video::ITexture * dcpp::io::IAttributes::getAttributeAsTexture	(	const c8 *	attributeName,
		video::ITexture *	defaultNotFound = `0`
	)		const

pure virtual

Gets an attribute as texture reference

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

◆ getAttributeAsTexture() [2/2]

virtual video::ITexture * dcpp::io::IAttributes::getAttributeAsTexture ( i32 index ) const

pure virtual

Gets an attribute as texture reference

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsTriangle3d() [1/2]

virtual nub::triangle3df dcpp::io::IAttributes::getAttributeAsTriangle3d	(	const c8 *	attributeName,
		const nub::triangle3df &	defaultNotFound = `nub::triangle3df(nub::vector3df(0, 0, 0), nub::vector3df(0, 0, 0), nub::vector3df(0, 0, 0))`
	)		const

pure virtual

Gets an attribute as a 3d triangle

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsTriangle3d() [2/2]

virtual nub::triangle3df dcpp::io::IAttributes::getAttributeAsTriangle3d ( i32 index ) const

pure virtual

Gets an attribute as 3d triangle

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsUserPointer() [1/2]

virtual void * dcpp::io::IAttributes::getAttributeAsUserPointer	(	const c8 *	attributeName,
		void *	defaultNotFound = `0`
	)		const

pure virtual

Gets an attribute as user pointer

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

◆ getAttributeAsUserPointer() [2/2]

virtual void * dcpp::io::IAttributes::getAttributeAsUserPointer ( i32 index ) const

pure virtual

Gets an attribute as user pointer

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsVector2d() [1/2]

virtual nub::vector2df dcpp::io::IAttributes::getAttributeAsVector2d	(	const c8 *	attributeName,
		const nub::vector2df &	defaultNotFound = `nub::vector2df(0, 0)`
	)		const

pure virtual

Gets an attribute as vector

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsVector2d() [2/2]

virtual nub::vector2df dcpp::io::IAttributes::getAttributeAsVector2d ( i32 index ) const

pure virtual

Gets an attribute as position

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsVector3d() [1/2]

virtual nub::vector3df dcpp::io::IAttributes::getAttributeAsVector3d	(	const c8 *	attributeName,
		const nub::vector3df &	defaultNotFound = `nub::vector3df(0, 0, 0)`
	)		const

pure virtual

Gets an attribute as 3d vector

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute()

◆ getAttributeAsVector3d() [2/2]

virtual nub::vector3df dcpp::io::IAttributes::getAttributeAsVector3d ( i32 index ) const

pure virtual

Gets an attribute as 3d vector

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeAsWstring() [1/3]

virtual nub::wstring dcpp::io::IAttributes::getAttributeAsWstring	(	const c8 *	attributeName,
		const nub::wstring &	defaultNotFound = `nub::wstring()`
	)		const

pure virtual

Gets an attribute as string.

Parameters

attributeName	Name of the attribute to get.
defaultNotFound	Value returned when attributeName was not found

Returns: Returns value of the attribute previously set by setAttribute() or defaultNotFound if attribute is not set.

◆ getAttributeAsWstring() [2/3]

virtual void dcpp::io::IAttributes::getAttributeAsWstring	(	const c8 *	attributeName,
		wchar_t *	target
	)		const

pure virtual

Gets an attribute as string.

Parameters

attributeName	Name of the attribute to get.
target	Buffer where the string is copied to.

◆ getAttributeAsWstring() [3/3]

virtual nub::wstring dcpp::io::IAttributes::getAttributeAsWstring ( i32 index ) const

pure virtual

Returns attribute value as string by index.

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeEnumerationLiteralsOfEnumeration() [1/2]

virtual void dcpp::io::IAttributes::getAttributeEnumerationLiteralsOfEnumeration	(	const c8 *	attributeName,
		nub::array< dcpp::nub::string > &	outLiterals
	)		const

pure virtual

Gets the list of enumeration literals of an enumeration attribute

Parameters

attributeName	Name of the attribute to get.
outLiterals	Set of strings to choose the enum name from.

◆ getAttributeEnumerationLiteralsOfEnumeration() [2/2]

virtual void dcpp::io::IAttributes::getAttributeEnumerationLiteralsOfEnumeration	(	i32	index,
		nub::array< dcpp::nub::string > &	outLiterals
	)		const

pure virtual

Gets the list of enumeration literals of an enumeration attribute

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
outLiterals	Set of strings to choose the enum name from.

◆ getAttributeName()

virtual const c8 * dcpp::io::IAttributes::getAttributeName ( i32 index ) const

pure virtual

Returns attribute name by index.

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeType() [1/2]

virtual E_ATTRIBUTE_TYPE dcpp::io::IAttributes::getAttributeType ( const c8 * attributeName ) const

pure virtual

Returns the type of an attribute

Parameters

attributeName Name for the attribute

◆ getAttributeType() [2/2]

virtual E_ATTRIBUTE_TYPE dcpp::io::IAttributes::getAttributeType ( i32 index ) const

pure virtual

Returns attribute type by index.

Parameters

index Index value, must be between 0 and getAttributeCount()-1.

◆ getAttributeTypeString() [1/2]

virtual const wchar_t * dcpp::io::IAttributes::getAttributeTypeString	(	const c8 *	attributeName,
		const wchar_t *	defaultNotFound = `L"unknown"`
	)		const

pure virtual

Returns the type string of the attribute

Parameters

attributeName	String for the attribute type
defaultNotFound	Value returned when attributeName was not found

◆ getAttributeTypeString() [2/2]

virtual const wchar_t * dcpp::io::IAttributes::getAttributeTypeString	(	i32	index,
		const wchar_t *	defaultNotFound = `L"unknown"`
	)		const

pure virtual

Returns the type string of the attribute by index.

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
defaultNotFound	Value returned for an invalid index

◆ read()

virtual bool dcpp::io::IAttributes::read	(	io::IXMLReader *	reader,
		bool	readCurrentElementOnly = `false`,
		const wchar_t *	elementName = `0`
	)

pure virtual

Reads attributes from a xml file.

Parameters

reader	The XML reader to read from
readCurrentElementOnly	If set to true, reading only works if current element has the name 'attributes' or the name specified using elementName.
elementName	The surrounding element name. If it is null, the default one, "attributes" will be taken. If set to false, the first appearing list of attributes are read.

◆ setAttribute() [1/5]

virtual void dcpp::io::IAttributes::setAttribute	(	const c8 *	attributeName,
		const c8 *	value
	)

pure virtual

Sets an attribute value as string.

Parameters

attributeName	Name for the attribute
value	Value for the attribute. Set this to 0 to delete the attribute

◆ setAttribute() [2/5]

virtual void dcpp::io::IAttributes::setAttribute	(	const c8 *	attributeName,
		const nub::array< nub::wstring > &	value
	)

pure virtual

Sets an attribute value as a wide string array.

Parameters

attributeName	Name for the attribute
value	Value for the attribute. Set this to 0 to delete the attribute

◆ setAttribute() [3/5]

virtual void dcpp::io::IAttributes::setAttribute	(	const c8 *	attributeName,
		const wchar_t *	value
	)

pure virtual

Sets an attribute value as string.

Parameters

attributeName	Name for the attribute
value	Value for the attribute. Set this to 0 to delete the attribute

◆ setAttribute() [4/5]

virtual void dcpp::io::IAttributes::setAttribute	(	i32	index,
		const c8 *	value
	)

pure virtual

Sets an attribute value as string.

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
value	String to which the attribute is set.

◆ setAttribute() [5/5]

virtual void dcpp::io::IAttributes::setAttribute	(	i32	index,
		const wchar_t *	value
	)

pure virtual

Sets an attribute value as string.

Parameters

index	Index value, must be between 0 and getAttributeCount()-1.
value	String to which the attribute is set.

◆ write()

virtual bool dcpp::io::IAttributes::write	(	io::IXMLWriter *	writer,
		bool	writeXMLHeader = `false`,
		const wchar_t *	elementName = `0`
	)

pure virtual

Write these attributes into a xml file

Parameters

writer	The XML writer to write to
writeXMLHeader	Writes a header to the XML file, required if at the beginning of the file
elementName	The surrounding element name. If it is null, the default one, "attributes" will be taken.

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

include/duckcpp/core/engine/IAttributes.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAttributeAsArray() [1/2]

◆ getAttributeAsArray() [2/2]

◆ getAttributeAsBinaryData() [1/2]

◆ getAttributeAsBinaryData() [2/2]

◆ getAttributeAsBool() [1/2]

◆ getAttributeAsBool() [2/2]

◆ getAttributeAsBox3d() [1/2]

◆ getAttributeAsBox3d() [2/2]

◆ getAttributeAsColor() [1/2]

◆ getAttributeAsColor() [2/2]

◆ getAttributeAsColorf() [1/2]

◆ getAttributeAsColorf() [2/2]

◆ getAttributeAsDimension2d() [1/2]

◆ getAttributeAsDimension2d() [2/2]

◆ getAttributeAsEnumeration() [1/4]

◆ getAttributeAsEnumeration() [2/4]

◆ getAttributeAsEnumeration() [3/4]

◆ getAttributeAsEnumeration() [4/4]

◆ getAttributeAsFloat() [1/2]

◆ getAttributeAsFloat() [2/2]

◆ getAttributeAsInt() [1/2]

◆ getAttributeAsInt() [2/2]

◆ getAttributeAsLine2d() [1/2]

◆ getAttributeAsLine2d() [2/2]

◆ getAttributeAsLine3d() [1/2]

◆ getAttributeAsLine3d() [2/2]

◆ getAttributeAsMatrix() [1/2]

◆ getAttributeAsMatrix() [2/2]

◆ getAttributeAsPlane3d() [1/2]

◆ getAttributeAsPlane3d() [2/2]

◆ getAttributeAsPosition2d() [1/2]

◆ getAttributeAsPosition2d() [2/2]

◆ getAttributeAsQuaternion() [1/2]

◆ getAttributeAsQuaternion() [2/2]

◆ getAttributeAsRect() [1/2]

◆ getAttributeAsRect() [2/2]

◆ getAttributeAsString() [1/3]

◆ getAttributeAsString() [2/3]

◆ getAttributeAsString() [3/3]

◆ getAttributeAsTexture() [1/2]

◆ getAttributeAsTexture() [2/2]

◆ getAttributeAsTriangle3d() [1/2]

◆ getAttributeAsTriangle3d() [2/2]

◆ getAttributeAsUserPointer() [1/2]

◆ getAttributeAsUserPointer() [2/2]

◆ getAttributeAsVector2d() [1/2]

◆ getAttributeAsVector2d() [2/2]

◆ getAttributeAsVector3d() [1/2]

◆ getAttributeAsVector3d() [2/2]

◆ getAttributeAsWstring() [1/3]

◆ getAttributeAsWstring() [2/3]

◆ getAttributeAsWstring() [3/3]

◆ getAttributeEnumerationLiteralsOfEnumeration() [1/2]

◆ getAttributeEnumerationLiteralsOfEnumeration() [2/2]

◆ getAttributeName()

◆ getAttributeType() [1/2]

◆ getAttributeType() [2/2]

◆ getAttributeTypeString() [1/2]

◆ getAttributeTypeString() [2/2]

◆ read()

◆ setAttribute() [1/5]

◆ setAttribute() [2/5]

◆ setAttribute() [3/5]

◆ setAttribute() [4/5]

◆ setAttribute() [5/5]

◆ write()