• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

step/stepcore

StepCore::Item

StepCore::Item Class Reference
[World]

#include <world.h>

Inheritance diagram for StepCore::Item:

Inheritance graph
[legend]

List of all members.


Detailed Description

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

Definition at line 69 of file world.h.


Public Member Functions

Color color () const
void deleteObjectErrors ()
ItemGroup * group () const
 Item (const Item &item)
 Item (const QString &name=QString())
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)
virtual ~Item ()

Protected Member Functions

virtual ObjectErrors * createObjectErrors ()

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 (  )  [inline, virtual]

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 (  )  [inline, protected, virtual]

For internal use only.

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

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

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  )  [inline, virtual]

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  )  [inline, virtual]

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

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

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  )  [inline, virtual]

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

step/stepcore

Skip menu "step/stepcore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
  •   stepcore
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal