ObjectAPI Class Reference

#include <S2_api.h>

Inheritance diagram for ObjectAPI:

[legend]List of all members.

Public Member Functions
bookkeeping methods
void	SetName (const char *name)
const char *	GetName ()
Shape/Geometry management
virtual void	AttachShape (void *p_shape)
virtual void	DettachShape (void *p_shape)
Protected Member Functions
	ObjectAPI (S2::Object *p_obj)
virtual	~ObjectAPI ()
Protected Attributes
S2::Object *	m_pObject
char	m_name [S2_MAX_NAME_LENGTH]
Private Member Functions
S2::Object *	GetObject () const
Friends
class	UniverseAPI
	Allows UniverseAPI to create/destroy ObjectAPI instances.

---

Detailed Description

API Generic Animation Object.

---

Constructor & Destructor Documentation

ObjectAPI::ObjectAPI (  S2::Object *  p_obj  )  [inline, protected]

virtual ObjectAPI::~ObjectAPI (   )  [inline, protected, virtual]

---

Member Function Documentation

virtual void ObjectAPI::AttachShape (  void *  p_shape  )  [inline, virtual]

virtual void ObjectAPI::DettachShape (  void *  p_shape  )  [inline, virtual]

const char * ObjectAPI::GetName (   )

S2::Object* ObjectAPI::GetObject (   )  const [inline, private]

void ObjectAPI::SetName (  const char *  name  )

---

Friends And Related Function Documentation

friend class UniverseAPI [friend]

Allows UniverseAPI to create/destroy ObjectAPI instances. Reimplemented in ParticleAPI, and RigidAPI.

---

Member Data Documentation

char ObjectAPI::m_name[S2_MAX_NAME_LENGTH] [protected]

S2::Object* ObjectAPI::m_pObject [protected]

---

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

• S2_api.h
• S2_api.cpp

---