Kigs Framework  Doc version 0.8
Open source multi purpose Rapid Application Development framework
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Sprite Class Reference

#include <Sprite.h>

Inheritance diagram for Sprite:
Drawable SceneNode CoreModifiable GenericRefCountedBaseClass

Public Member Functions

 Sprite (const kstl::string &name, DECLARE_CLASS_NAME_TREE_ARG)
 constructor More...
 
virtual void setPosition (kfloat x, kfloat y)
 set the position More...
 
virtual void setTexture (const kfloat &u1, const kfloat &v1, const kfloat &u2, const kfloat &v2)
 set the texture More...
 
virtual void setSize (const kfloat &s)
 set the size More...
 
virtual void setSize (const kfloat &sx, const kfloat &sy)
 set the size More...
 
virtual void getSize (kfloat &sx, kfloat &sy)
 get the size More...
 
virtual void changeTexture (kstl::string FileName)
 change the texture More...
 
- Public Member Functions inherited from Drawable
virtual void DoPreDraw (TravState *)
 pre draw method More...
 
virtual void DoDraw (TravState *travstate)
 draw method More...
 
virtual void DoPostDraw (TravState *travstate)
 post draw method More...
 
void CheckPostDraw (TravState *travstate)
 check before calling corresponding DoPredraw More...
 
virtual bool BBoxUpdate (kdouble time)
 update the bounding box More...
 
bool addItem (const CMSP &item, ItemPosition pos=Last) override
 add item in scene tree More...
 
bool removeItem (const CMSP &item) override
 remove item in scene tree More...
 
virtual void GetGlobalPosition (Matrix3x4 *pLocalToGlobal, kfloat &x, kfloat &y, kfloat &z)
 get the global position of the drawable More...
 
- Public Member Functions inherited from SceneNode
bool addItem (const CMSP &item, ItemPosition pos=Last DECLARE_DEFAULT_LINK_NAME) override
 add item at first or last position
 
- Public Member Functions inherited from CoreModifiable
void Init ()
 Modifiable managmenent.
 
void EmptyItemList ()
 remove all items (sons)
 
CMSP GetInstanceByPath (const std::string &path)
 return the instance corresponding to the given path in sons tree
 
std::string GetRuntimeID () const
 ID.
 
CoreModifiableAttributegetAttribute (KigsID labelid) const
 Attribute management.
 
u32 getNbArrayElements (KigsID attributeLabel) const
 return element count for an array type attribute
 
template<typename attribute_type , typename value_type >
attribute_type * AddDynamicAttribute (KigsID ID, const value_type &value)
 Dynamic attribute management.
 
const kigs::unordered_map< KigsID, ModifiableMethodStruct > * GetMethods ()
 Method management.
 
bool aggregateWith (CMSP &item, ItemPosition pos=Last)
 Aggregate management.
 
void flagAsNotificationCenterRegistered ()
 Flags.
 
void InitParametersFromList (const std::vector< CoreModifiableAttribute * > *params)
 Utility. More...
 
virtual void UninitModifiable ()
 called when InitModifiable has failled : reset read/write flag on all init params More...
 
virtual void ProtectedDestroy ()
 Destroy method decrement refcounter and delete instance if no more used. More...
 
virtual void addUser (CoreModifiable *user)
 add the given parent to list
 
virtual void removeUser (CoreModifiable *user)
 remove user (parent)
 

Protected Member Functions

virtual ~Sprite ()
 destructor
 
void InitModifiable () override
 initialize modifiable
 
- Protected Member Functions inherited from Drawable
virtual bool PreDraw (TravState *)
 initialise pre draw method More...
 
virtual bool Draw (TravState *)
 initialise draw method More...
 
virtual bool PostDraw (TravState *)
 initialise PostDraw method More...
 
virtual void FatherNode3DNeedBoundingBoxUpdate ()
 update the father node bounding box
 
- Protected Member Functions inherited from CoreModifiable
void UpdateAggregates (const Timer &timer, void *addParam)
 Internals.
 
void Export (std::vector< CoreModifiable * > &savedList, XMLNode *currentNode, bool recursive, ExportSettings *settings)
 Export. More...
 
CoreModifiableAttributeGenericCreateDynamicAttribute (CoreModifiable::ATTRIBUTE_TYPE type, KigsID ID)
 create and add dynamic attribute except arrays
 

Protected Attributes

maString mTextureFileName
 file name of the used texture
 
maFloat mDisplacement
 displacement
 
maFloat mPosX
 position on x axis
 
maFloat mPosY
 position on y axis
 
maFloat mSizeX
 size on x axis
 
maFloat mSizeY
 size on y axis
 
maFloat mTexu1
 coord texture u
 
maFloat mTexu2
 coord texture u
 
maFloat mTexv1
 coord texture v
 
maFloat mTexv2
 coord texture v
 
maVect4DF mColor
 color
 
SP< TexturemTexture
 link to the texture
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreModifiable
static std::vector< CMSP > GetRootInstances (const KigsID &cid, bool exactTypeOnly=false)
 static method : return the set of all root instances of the given type
 
static void Append (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (const std::string &filename, CoreModifiable *toexport, bool recursive=false, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static XMLNodeExportToXMLNode (CoreModifiable *toexport, XML *owner_xml_file, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML Node. if recursive flag is set to true, export also all sons tree More...
 
static std::string ExportToXMLString (CoreModifiable *toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static CMSP Import (const std::string &filename, bool noInit=false, bool keepImportFileName=false, ImportState *state=nullptr, const std::string &override_name="")
 return an new CoreModifiable instance using the description found in XML file given by name
 
static CMSP GetInstanceByGlobalPath (const std::string &path)
 static method : return the instance corresponding to the given path, and given search start
 
static void debugPrintfFullTree (int maxindent=3)
 Editor. More...
 
- Static Protected Member Functions inherited from CoreModifiable
template<typename StringType >
static CMSP Import (XMLNodeTemplate< StringType > *currentNode, CoreModifiable *currentModifiable, ImportState &importState)
 recusrive method to add sons and attributes found in the XML file
 

Detailed Description

Draw a sprite in the 3D scene.

?? obsolete ?? can be replaced by Billboard 3D or AutoOrientedNode3D or UINode3DLayer ?

Constructor & Destructor Documentation

◆ Sprite()

Sprite::Sprite ( const kstl::string &  name,
DECLARE_CLASS_NAME_TREE_ARG   
)

constructor

Parameters
name: instance name
DECLARE_CLASS_NAME_TREE_ARG: list of arguments

Member Function Documentation

◆ changeTexture()

void Sprite::changeTexture ( kstl::string  FileName)
virtual

change the texture

Parameters
FileName: file name of the texture

◆ getSize()

void Sprite::getSize ( kfloat &  sx,
kfloat &  sy 
)
inlinevirtual

get the size

Parameters
sx: size on x axis (in/out param)
sy: size on y axis (in/out param)

◆ setPosition()

void Sprite::setPosition ( kfloat  x,
kfloat  y 
)
inlinevirtual

set the position

Parameters
x: position on x axis
y: position on y axis

◆ setSize() [1/2]

void Sprite::setSize ( const kfloat &  s)
inlinevirtual

set the size

Parameters
s: new size

◆ setSize() [2/2]

void Sprite::setSize ( const kfloat &  sx,
const kfloat &  sy 
)
inlinevirtual

set the size

Parameters
sx: size on x axis
sy: size on y axis

◆ setTexture()

void Sprite::setTexture ( const kfloat &  u1,
const kfloat &  v1,
const kfloat &  u2,
const kfloat &  v2 
)
inlinevirtual

set the texture

Parameters
u1:
v1:
u2:
v2:

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