A3DL::Sector

A3DL::Sector Class Reference
[libmetaobject_a3dl]

#include <vos/metaobjects/a3dl/sector.hh>

Inheritance diagram for A3DL::Sector:

Detailed Description

A sector is a grouping of 3D objects that can be considered a seperate, mostly self-contained entity from other sectors.

Sectors may be linked through Portal objects, though. Child objects are considered to be "in" this sector. (Sectors have not fixed bounds)

Definition at line 44 of file sector.hh.

Public Member Functions

Sector (VOS::VobjectBase *superobject)
~Sector ()
virtual const std::string getVOSType ()

void setFogColor (float r, float g, float b)
A general "fog" or "haze" that fills the whole sector obscuring distant objects.
void getFogColor (float &r, float &g, float &b)
void setFogDensity (double d)
double getFogDensity ()
VUtil::vRef< VOS::Property > getFogColorObj ()
VUtil::vRef< VOS::Property > getFogDensityObj ()

virtual void setGravity (double unitsPerSecond)
Gravity acceleration.
virtual double getGravity ()
virtual VUtil::vRef< VOS::Property > getGravityObj ()

virtual void setCollisionDetection (bool enabled)
Whether clients ought to perform collision detection for objects within this sector.
virtual bool getCollisionDetection ()
virtual VUtil::vRef< VOS::Property > getCollisionDetectionObj ()

void setAmbientLightColor (float r, float g, float b)
A general ambient light to apply to all objects in the sector.
void getAmbientLightColor (float &r, float &g, float &b)
VUtil::vRef< VOS::Property > getAmbientLightColorObj ()

void setWelcomeMessage (const std::string &msg, const std::string &type="text/plain")
A message for clients to display upon initially joining the sector.
std::string getWelcomeMessage ()
std::string getWelcomeMessageDataType ()
VUtil::vRef< VOS::Property > getWelcomeMessageObj ()

Static Public Member Functions

static VOS::MetaObject * new_Sector (VOS::VobjectBase *superobject, const std::string &type)

Constructor & Destructor Documentation

A3DL::Sector::Sector ( VOS::VobjectBase * superobject )

A3DL::Sector::~Sector ( )

Member Function Documentation

void A3DL::Sector::getAmbientLightColor	(	float &	r,
		float &	g,
		float &	b
	)

VUtil::vRef<VOS::Property> A3DL::Sector::getAmbientLightColorObj ( )

virtual bool A3DL::Sector::getCollisionDetection ( ) [virtual]

virtual VUtil::vRef<VOS::Property> A3DL::Sector::getCollisionDetectionObj ( ) [virtual]

void A3DL::Sector::getFogColor	(	float &	r,
		float &	g,
		float &	b
	)

VUtil::vRef<VOS::Property> A3DL::Sector::getFogColorObj ( )

double A3DL::Sector::getFogDensity ( )

VUtil::vRef<VOS::Property> A3DL::Sector::getFogDensityObj ( )

virtual double A3DL::Sector::getGravity ( ) [virtual]

virtual VUtil::vRef<VOS::Property> A3DL::Sector::getGravityObj ( ) [virtual]

virtual const std::string A3DL::Sector::getVOSType ( ) [virtual]

Returns:: the specific VOS type name that represents the VOS interface this object is supplying. This should always be overridden by the subclass.

Reimplemented from VOS::MetaObject.

std::string A3DL::Sector::getWelcomeMessage ( )

std::string A3DL::Sector::getWelcomeMessageDataType ( )

VUtil::vRef<VOS::Property> A3DL::Sector::getWelcomeMessageObj ( )

static VOS::MetaObject* A3DL::Sector::new_Sector	(	VOS::VobjectBase *	superobject,
		const std::string &	type
	)			`[static]`

void A3DL::Sector::setAmbientLightColor	(	float	r,
		float	g,
		float	b
	)

A general ambient light to apply to all objects in the sector.

virtual void A3DL::Sector::setCollisionDetection ( bool enabled ) [virtual]

Whether clients ought to perform collision detection for objects within this sector.

void A3DL::Sector::setFogColor	(	float	r,
		float	g,
		float	b
	)

A general "fog" or "haze" that fills the whole sector obscuring distant objects.

void A3DL::Sector::setFogDensity ( double d )

virtual void A3DL::Sector::setGravity ( double unitsPerSecond ) [virtual]

Gravity acceleration.

void A3DL::Sector::setWelcomeMessage	(	const std::string &	msg,
		const std::string &	type = `"text/plain"`
	)

A message for clients to display upon initially joining the sector.

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

/home/tetron/hack/vos/libs/vos/metaobjects/a3dl/sector.hh