Public Member Functions | Protected Member Functions | Protected Attributes

sp::BaseObject Class Reference

This is the base object class. It only stores the object's name and a user data pointer for general purpose. More...

#include <spBaseObject.hpp>

Inheritance diagram for sp::BaseObject:
sp::network::NetworkMember sp::Node sp::physics::PhysicsBaseObject sp::scene::AnimationJoint sp::scene::AnimationPlayback sp::scene::CharacterController sp::scene::CollisionMaterial sp::scene::CollisionNode sp::scene::TreeNode sp::tool::PathEdge sp::tool::PathNode sp::video::ShaderClass sp::video::Texture

List of all members.

Public Member Functions

virtual ~BaseObject ()
void setUserData (void *Data)
void * getUserData () const
void setUserDataFlags (s32 Flags)
s32 getUserDataFlags () const
void setName (const io::stringc &Name)
 Sets the objects's name.
io::stringc getName () const
 Returns the objects's name.

Protected Member Functions

 BaseObject ()
 BaseObject (const io::stringc &Name)

Protected Attributes

void * UserData_
s32 UserDataFlags_
io::stringc Name_

Detailed Description

This is the base object class. It only stores the object's name and a user data pointer for general purpose.

Constructor & Destructor Documentation

virtual sp::BaseObject::~BaseObject (  )  [inline, virtual]
sp::BaseObject::BaseObject (  )  [inline, protected]
sp::BaseObject::BaseObject ( const io::stringc &  Name  )  [inline, protected]

Member Function Documentation

io::stringc sp::BaseObject::getName (  )  const [inline]

Returns the objects's name.

void* sp::BaseObject::getUserData (  )  const [inline]
Returns:
Pointer to an individual data field which can be defined by the user. Use ANSI-C casting e.g. like: "MyDataStructure* MyData = (MyDataStructure*)MyNodeObject->getUserData();". The pointer type must be the same which has been set before with "setUserData".
s32 sp::BaseObject::getUserDataFlags (  )  const [inline]

Returns the user data flags. By default 0.

See also:
getUserData
Since:
Version 3.2
void sp::BaseObject::setName ( const io::stringc &  Name  )  [inline]

Sets the objects's name.

void sp::BaseObject::setUserData ( void *  Data  )  [inline]

Sets the user data.

Parameters:
Data,: Pointer to an individual data field which can be defined by the user. By default 0 when the pointer is unused.
void sp::BaseObject::setUserDataFlags ( s32  Flags  )  [inline]

Sets the user data flags. Use this to determine from which type the user data is.

See also:
setUserData
Since:
Version 3.2

Member Data Documentation

io::stringc sp::BaseObject::Name_ [protected]
void* sp::BaseObject::UserData_ [protected]
s32 sp::BaseObject::UserDataFlags_ [protected]
The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:54 for SoftPixel Engine by  doxygen 1.7.1