Class hierarchy Compound list File list Compound Members

# World_Object Class Reference

A World_Object is a renderable, advancable entity that exists within a World. More...

Inherits Object.

Inherited by World.

List of all members.

## Public Members

- enum AdvRetCode { rcOK , rcREMOVE , rcDELETE , rcSKIP }
    These flags can be returned by the advance(), preAdvance(), or postAdvance() functions to remove an object from its parent.

- virtual long add (Object* O)
    this checks to make sure that any Object added to a World_Object is derived from World_Object.

- World* getWorld ()
    return the world that this belongs to.

- void setWorld (World* w)
    Set a new world.

- virtual long renderSons ()
    Returns non zero if object wants son objects rendered.

- virtual long preRender (View& view)
    This method is called once before any rendering is done.

- virtual long render (View& view)
    Subclases must override this to supply rendering.

- virtual long postRender (View& view)
    This method is called once after all rendering is done.

- virtual long preAdvance (float Fraction)
    This method is called once before any object is advanced.

- virtual long advance (float Fraction)
    Subclasses may override this to provide state changes.

- virtual long postAdvance (float Fraction)
    This method is called once after any object is advanced.

## Detailed Description

A World_Object is a renderable, advancable entity that exists within a World.

## Member Enumeration Type Documentation

### enum World_Object::AdvRetCode

These flags can be returned by the advance(), preAdvance(), or postAdvance() functions to remove an object from its parent.

The rcDELETE flag will additionally schedule a deletion.

## Member Function Documentation

### virtual long World_Object::add(Object* O)`[virtual]`

this checks to make sure that any Object added to a World_Object is derived from World_Object.

Returns -1 if dynamic_cast fails.

Reimplemented from Object.

Reimplemented in World.

### World* World_Object::getWorld()

return the world that this belongs to.

a world will return itself.

### void World_Object::setWorld(World* w)

Set a new world.

If current world is not NULL, the object is also removed from it.

### virtual long World_Object::renderSons()`[virtual]`

Returns non zero if object wants son objects rendered.

### virtual long World_Object::preRender(View& view)`[virtual]`

This method is called once before any rendering is done.

It should return non-zero to skip rendering.

Reimplemented in World.

### virtual long World_Object::render(View& view)`[virtual]`

Subclases must override this to supply rendering.

Reimplemented in World.

### virtual long World_Object::postRender(View& view)`[virtual]`

This method is called once after all rendering is done.

Reimplemented in World.

### virtual long World_Object::preAdvance(float Fraction)`[virtual]`

This method is called once before any object is advanced.

### virtual long World_Object::advance(float Fraction)`[virtual]`

Subclasses may override this to provide state changes.

Fraction gives the amount of time to provide change for (in seconds).

Reimplemented in World.

### virtual long World_Object::postAdvance(float Fraction)`[virtual]`

This method is called once after any object is advanced.

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

- WO_Object.h