StepCore::Item Class Reference

#include <world.h>

Inheritance diagram for StepCore::Item:

Public Member Functions
	Item (const QString &name=QString())
	Item (const Item &item)
virtual	~Item ()
Color	color () const
void	deleteObjectErrors ()
ItemGroup *	group () const
ObjectErrors *	objectErrors ()
Item &	operator= (const Item &item)
void	setColor (Color color)
virtual void	setGroup (ItemGroup *group)
virtual void	setWorld (World *world)
ObjectErrors *	tryGetObjectErrors () const
World *	world () const
virtual void	worldItemRemoved (Item *item STEPCORE_UNUSED)
Public Member Functions inherited from StepCore::Object
	Object (const QString &name=QString())
virtual	~Object ()
const QString &	name () const
void	setName (const QString &name)

Protected Member Functions
virtual ObjectErrors *	createObjectErrors ()

Additional Inherited Members
Protected Attributes inherited from StepCore::Object
QString	_name

Detailed Description

The root class for any world items (bodies and forces)

Definition at line 69 of file world.h.

Constructor & Destructor Documentation

StepCore::Item::Item ( const QString &  name = QString() )

inline

Constructs Item.

Definition at line 76 of file world.h.

StepCore::Item::Item ( const Item &  item )

inline

Constructs a copy of item.

Definition at line 80 of file world.h.

virtual StepCore::Item::~Item ( )

inlinevirtual

Destroys Item.

Definition at line 82 of file world.h.

Member Function Documentation

Color StepCore::Item::color ( ) const

inline

Get item color (for use in GUI)

Definition at line 109 of file world.h.

virtual ObjectErrors* StepCore::Item::createObjectErrors ( )

inlineprotectedvirtual

Creates specific ObjectErrors-derived class (to be reimplemented in derived classes)

Reimplemented in StepCore::RigidBody, StepCore::ChargedParticle, StepCore::Spring, StepCore::Gas, StepCore::Particle, StepCore::WeightForce, StepCore::GasLJForce, StepCore::CoulombForce, and StepCore::GravitationForce.

Definition at line 124 of file world.h.

void StepCore::Item::deleteObjectErrors ( )

inline

Delete objectErrors.

Definition at line 106 of file world.h.

ItemGroup* StepCore::Item::group ( ) const

inline

Get pointer to ItemGroup in which this object lives.

Definition at line 97 of file world.h.

ObjectErrors * StepCore::Item::objectErrors

(

)

Get existing ObjectErrors or try to create it.

Definition at line 67 of file world.cc.

Item& StepCore::Item::operator=

(

const Item &

item

)

Assignment operator (copies objectErrors if necessary)

void StepCore::Item::setColor ( Color  color )

inline

Set item color (for use in GUI)

Definition at line 112 of file world.h.

virtual void StepCore::Item::setGroup ( ItemGroup *  group )

inlinevirtual

Set/change pointer to ItemGroup in which this object lives.

Definition at line 94 of file world.h.

virtual void StepCore::Item::setWorld ( World *  world )

inlinevirtual

Set/change pointer to World in which this object lives.

Reimplemented in StepCore::ItemGroup, and StepCore::SoftBody.

Definition at line 88 of file world.h.

ObjectErrors* StepCore::Item::tryGetObjectErrors ( ) const

inline

Get ObjectErrors only if it already exists.

Definition at line 100 of file world.h.

World* StepCore::Item::world ( ) const

inline

Get pointer to World in which this object lives.

Definition at line 91 of file world.h.

virtual void StepCore::Item::worldItemRemoved ( Item *item  STEPCORE_UNUSED )

inlinevirtual

Called by the World when any item is about to be removed from the world.

Parameters

item	Pointer to item about to be removed

Todo:

XXX rename

Definition at line 119 of file world.h.

---

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

• world.h
• world.cc