KT_asm_model_scene Class Reference
[Kinematics Toolkit :: GGCM/ACIS Bridge]

A kinematics scene consists of a set of robots a set of background objects and a set of paths for the robots to follow. More...

#include <KT_asm_model_scene.hxx>

Inheritance diagram for KT_asm_model_scene:

[legend]

Collaboration diagram for KT_asm_model_scene:

[legend]

List of all members.

Public Types
enum	scene_status_e {   STEP_DONE = KT_scene::STEP_DONE,   STEP_OK = KT_scene::STEP_OK,   STEP_ERROR = KT_scene::STEP_ERROR,   STEP_CLASH = KT_scene::STEP_CLASH }
	Simulation status. More...
Public Member Functions
	KT_asm_model_scene (asm_model *model)
	Initializes the member variables from the input data.
asm_model *	model () const
	Accessor to underlying asm_model object.
KT_GGCM_scene *	scene () const
	Accessor to underlying KT_GGCM_scene object.
	~KT_asm_model_scene ()
	Delete any BODY objects and release any memory.
Private Attributes
asm_model_holder	m_model
	Assembly model holder containing the scene.
KT_GGCM_scene *	m_scene
	GGCM scene.

---

Detailed Description

A kinematics scene consists of a set of robots a set of background objects and a set of paths for the robots to follow.

Role:

The scene object acts as a container for the kinematics objects in the scene, it also provides mechanisms to move the robots and check if there are clashes between objects.

---

Member Enumeration Documentation

enum KT_asm_model_scene::scene_status_e

Simulation status.

See also:

KT_scene::scene_status_e

Enumerator:

STEP_DONE	The simulation completed successfully.
STEP_OK	The step completed successfully.
STEP_ERROR	There was an error in the step.
STEP_CLASH	An object clashed in the step.

---

Constructor & Destructor Documentation

KT_asm_model_scene::KT_asm_model_scene

(

asm_model *

model

)

Initializes the member variables from the input data.

Role:

Container class that holds a pointer to a KT_GGCM_scene, and its corresponding asm_model

Parameters:

model

- Assembly model linked to the KT_GGCM_scene

KT_asm_model_scene::~KT_asm_model_scene

(

)

Delete any BODY objects and release any memory.

---

Member Function Documentation

asm_model* KT_asm_model_scene::model

(

)

const [inline]

Accessor to underlying asm_model object.

KT_GGCM_scene* KT_asm_model_scene::scene

(

)

const [inline]

Accessor to underlying KT_GGCM_scene object.

---

Member Data Documentation

asm_model_holder KT_asm_model_scene::m_model [private]

Assembly model holder containing the scene.

KT_GGCM_scene* KT_asm_model_scene::m_scene [private]

GGCM scene.