OMK::Iii

OMK::Iii Namespace Reference

Classes

class AccessRule

class SimpleConnectorT

The implementation class for simple connectors. More...

class SharedConnectorT

The implementation class for shared connectors. More...

class AssociatedConnectorT

The implementation class for associated connectors. More...

class AverageT

Convertor class which calculates the average of values. More...

class Barycenter

class IntegratorT

Convertor class which integrate the input value. More...

class IAccessRule

Access rule interface. More...

class AccessRuleCreator

Ancestor of every access rule creator class used by the PrototypeFactory. More...

class AccessRuleCreatorT

Access rule creator class to be parametrized by the descendants of IAccessRule. More...

class IConnector

Connector interface. More...

class ConnectorCreator

Ancestor of every Connector creator class used by the PrototypeFactory. More...

class ConnectorCreatorT

Connector creator class to be parametrized by the descendants of IConnector. More...

class IConvertorT

The interface class for convertor. More...

class IConvertorCreator

Ancestor of every convertor creator class used by the PrototypeFactory. More...

class ConvertorCreatorT

Convertor creator class to be parametrized by the descendants of IConvertorT. More...

class ConvertorFactoryT

The factory of the average object. More...

class InteractiveExtension

The extension to make an object interactive. More...

class InteractorExtension

Ancestor of every interactive, interactor or inspector objects. More...

class InteractorOutput

This class defines informations about interactor output. More...

class InteractorOutputCreator

Ancestor of every Interactor output creator class used by the PrototypeFactory. More...

class InteractorOutputCreatorT

Connector creator of InteractorOutputT. More...

class InteractorOutputT

class JointCreator

Ancestor of every Joint creator class used by the PrototypeFactory. More...

class JointCreatorT

Joint creator class to be parametrized by the descendants of Joint. More...

class Joint

Ancestor of every joint, it is a lock joint. More...

class BallJoint

Ball joint. More...

class HingeSlideJoint

class ScrewJoint

class JointInteractorExtension

The interactor extension associated to the joint extension. More...

class JointExtension

Kinematic joint between two objects. More...

class SessionPrm

Define a session of interaction between an interactor and an interactive object. More...

Typedefs

typedef AverageT< float > AverageFloat

Average for float.

typedef AverageT< double > AverageDouble

Average for double.

typedef IntegratorT< int > IntegratorInt

Integrator for int.

typedef IntegratorT< float > IntegratorFloat

Integrator for float.

typedef IntegratorT< double > IntegratorDouble

Integrator for double.

typedef std::pair< Name, Name > InteractorOutputsIndex

Define what is a index of interactor outputs, a pair of ids.

typedef std::map< InteractorOutputsIndex,
InteractorOutput * > InteractorOutputsMap

Define what is a map of interactor outputs.

typedef std::map< Name, SessionPrm * > SessionsMap

Define what is a map of interaction parameters.

typedef OBT::Singleton< OBT::PrototypeFactory<
OMK::Name, JointCreator > > JointFactory

The factory of the extension.

Functions

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, OMK::Type::Transform)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, int)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, float)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, bool)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, OMK::Type::Transform)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, int)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, float)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, OMK::Type::Transform)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, int)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, float)

REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, bool)

REGISTER_CONVERTOR_FACTORY (Barycenter, OMK::Type::Transform, std::vector< OMK::Type::Transform >,"Barycenter")

REGISTER_TEMPLATE_CONVERTOR_FACTORY (AverageFloat, float, std::vector< float >,"AverageFloat")

REGISTER_TEMPLATE_CONVERTOR_FACTORY (AverageDouble, double, std::vector< double >,"AverageDouble")

REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorInt, int, int,"IntegratorInt")

REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorFloat, float, float,"IntegratorFloat")

REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorDouble, double, double,"IntegratorDouble")

REGISTER_JOINT_FACTORY (Joint,"Lock")

REGISTER_JOINT_FACTORY (BallJoint,"Ball")

REGISTER_JOINT_FACTORY (HingeSlideJoint,"Hinge")

REGISTER_JOINT_FACTORY (ScrewJoint,"Screw")

REGISTER_EXTENSION_FACTORY (JointExtension,"Joint")

SessionPrm & getAccessibleParameters (SessionPrm &s)

SessionPrm & controlTakeOverAndGetCurrentValues (SessionPrm &s)

SessionPrm & controlRelease (SessionPrm &s)

SessionPrm & controlFreeze (SessionPrm &s)

SessionPrm & controlUnfreeze (SessionPrm &s)

Typedef Documentation

typedef AverageT< double > OMK::Iii::AverageDouble

Average for double.

Definition at line 79 of file OMKConvertors.h.

typedef AverageT< float > OMK::Iii::AverageFloat

Average for float.

Definition at line 77 of file OMKConvertors.h.

typedef IntegratorT< double > OMK::Iii::IntegratorDouble

Integrator for double.

Definition at line 133 of file OMKConvertors.h.

typedef IntegratorT< float > OMK::Iii::IntegratorFloat

Integrator for float.

Definition at line 131 of file OMKConvertors.h.

typedef IntegratorT< int > OMK::Iii::IntegratorInt

Integrator for int.

Definition at line 129 of file OMKConvertors.h.

typedef std::pair< Name, Name > OMK::Iii::InteractorOutputsIndex

Define what is a index of interactor outputs, a pair of ids.

The first is the category id, the second is the type id.

Definition at line 111 of file OMKInteractiveEventId.h.

typedef std::map< InteractorOutputsIndex, InteractorOutput* > OMK::Iii::InteractorOutputsMap

Define what is a map of interactor outputs.

Definition at line 116 of file OMKInteractiveEventId.h.

typedef std::map< Name, SessionPrm* > OMK::Iii::SessionsMap

Define what is a map of interaction parameters.

Definition at line 118 of file OMKInteractiveEventId.h.

Function Documentation

SessionPrm& OMK::Iii::controlFreeze ( SessionPrm & s ) [inline]

See selfControlFreeze. and Example of session.
Example of use


for id1 and id2 outputs 

session.c( id1 ).c( id2 ).c( controlFreeze ) ; 
for all the available connectors 

session.c( controlFreeze ) ;

Definition at line 290 of file OMKSessionPrm.h.

References OMK::Iii::SessionPrm::selfControlFreeze().

00291 {
00292   s.selfControlFreeze() ;
00293   return s ;
00294 }

SessionPrm& OMK::Iii::controlRelease ( SessionPrm & s ) [inline]

See selfControlRelease. and Example of session.
Example of use


for id1 and id2 outputs 

session.c( id1 ).c( id2 ).c( controlRelease ) ; 
for all the available connectors 

session.c( controlRelease ) ;

Definition at line 284 of file OMKSessionPrm.h.

References OMK::Iii::SessionPrm::selfControlRelease().

Referenced by OMK::Iii::InteractorExtension::closeSessionWith(), and OMK::Iii::JointInteractorExtension::stopRetroPropagation().

00285 {
00286   s.selfControlRelease() ;
00287   return s ;
00288 }

SessionPrm& OMK::Iii::controlTakeOverAndGetCurrentValues ( SessionPrm & s ) [inline]

See selfControlTakeOver. and Example of session.
Example of use


for id1 and id2 outputs 

session.c( id1 ).c( id2 ).c( controlTakeOver ) ; 
for all the available connectors 

session.c( controlTakeOver ) ;

Definition at line 278 of file OMKSessionPrm.h.

References OMK::Iii::SessionPrm::selfControlTakeOverAndGetCurrentValues().

Referenced by OMK::Iii::JointInteractorExtension::startRetroPropagation().

00279 {
00280   s.selfControlTakeOverAndGetCurrentValues() ;
00281   return s ;
00282 }

SessionPrm& OMK::Iii::controlUnfreeze ( SessionPrm & s ) [inline]

See selfControlUnfreeze. and Example of session.
Example of use


for id1 and id2 outputs 

session.c( id1 ).c( id2 ).c( controlUnfreeze ) ; 
for all the available connectors 

session.c( controlUnfreeze ) ;

Definition at line 296 of file OMKSessionPrm.h.

References OMK::Iii::SessionPrm::selfControlUnfreeze().

00297 {
00298   s.selfControlUnfreeze() ;
00299   return s ;
00300 }

SessionPrm& OMK::Iii::getAccessibleParameters ( SessionPrm & s ) [inline]

See selfGetParameters and Example of session.
Example of use

session.c( getParameters ) ;

Definition at line 272 of file OMKSessionPrm.h.

References OMK::Iii::SessionPrm::selfGetAccessibleParameters().

Referenced by OMK::Iii::InteractorExtension::startSessionWith().

00273 {
00274   s.selfGetAccessibleParameters() ;
00275   return s ;
00276 }

OMK::Iii::REGISTER_CONVERTOR_FACTORY	(	Barycenter	,
		OMK::Type::Transform	,
		std::vector< OMK::Type::Transform >	,
		"Barycenter"
	)

OMK::Iii::REGISTER_EXTENSION_FACTORY	(	JointExtension	,
		"Joint"
	)

OMK::Iii::REGISTER_JOINT_FACTORY	(	ScrewJoint	,
		"Screw"
	)

OMK::Iii::REGISTER_JOINT_FACTORY	(	HingeSlideJoint	,
		"Hinge"
	)

OMK::Iii::REGISTER_JOINT_FACTORY	(	BallJoint	,
		"Ball"
	)

OMK::Iii::REGISTER_JOINT_FACTORY	(	Joint	,
		"Lock"
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	AssociatedConnectorT	,
		bool
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	AssociatedConnectorT	,
		float
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	AssociatedConnectorT	,
		int
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	AssociatedConnectorT	,
		OMK::Type::Transform
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SharedConnectorT	,
		float
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SharedConnectorT	,
		int
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SharedConnectorT	,
		OMK::Type::Transform
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SimpleConnectorT	,
		bool
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SimpleConnectorT	,
		float
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SimpleConnectorT	,
		int
	)

OMK::Iii::REGISTER_TEMPLATE_CONNECTOR_FACTORY	(	SimpleConnectorT	,
		OMK::Type::Transform
	)

OMK::Iii::REGISTER_TEMPLATE_CONVERTOR_FACTORY	(	IntegratorDouble	,
		double	,
		double	,
		"IntegratorDouble"
	)

OMK::Iii::REGISTER_TEMPLATE_CONVERTOR_FACTORY	(	IntegratorFloat	,
		float	,
		float	,
		"IntegratorFloat"
	)

OMK::Iii::REGISTER_TEMPLATE_CONVERTOR_FACTORY	(	IntegratorInt	,
		int	,
		int	,
		"IntegratorInt"
	)

OMK::Iii::REGISTER_TEMPLATE_CONVERTOR_FACTORY	(	AverageDouble	,
		double	,
		std::vector< double >	,
		"AverageDouble"
	)

OMK::Iii::REGISTER_TEMPLATE_CONVERTOR_FACTORY	(	AverageFloat	,
		float	,
		std::vector< float >	,
		"AverageFloat"
	)

Documentation generated on Mon Jun 9 11:46:04 2008
Generated with doxygen by Dimitri van Heesch , 1997-2007


Classes
class	AccessRule
class	SimpleConnectorT
	The implementation class for simple connectors. More...
class	SharedConnectorT
	The implementation class for shared connectors. More...
class	AssociatedConnectorT
	The implementation class for associated connectors. More...
class	AverageT
	Convertor class which calculates the average of values. More...
class	Barycenter
class	IntegratorT
	Convertor class which integrate the input value. More...
class	IAccessRule
	Access rule interface. More...
class	AccessRuleCreator
	Ancestor of every access rule creator class used by the PrototypeFactory. More...
class	AccessRuleCreatorT
	Access rule creator class to be parametrized by the descendants of IAccessRule. More...
class	IConnector
	Connector interface. More...
class	ConnectorCreator
	Ancestor of every Connector creator class used by the PrototypeFactory. More...
class	ConnectorCreatorT
	Connector creator class to be parametrized by the descendants of IConnector. More...
class	IConvertorT
	The interface class for convertor. More...
class	IConvertorCreator
	Ancestor of every convertor creator class used by the PrototypeFactory. More...
class	ConvertorCreatorT
	Convertor creator class to be parametrized by the descendants of IConvertorT. More...
class	ConvertorFactoryT
	The factory of the average object. More...
class	InteractiveExtension
	The extension to make an object interactive. More...
class	InteractorExtension
	Ancestor of every interactive, interactor or inspector objects. More...
class	InteractorOutput
	This class defines informations about interactor output. More...
class	InteractorOutputCreator
	Ancestor of every Interactor output creator class used by the PrototypeFactory. More...
class	InteractorOutputCreatorT
	Connector creator of InteractorOutputT. More...
class	InteractorOutputT
class	JointCreator
	Ancestor of every Joint creator class used by the PrototypeFactory. More...
class	JointCreatorT
	Joint creator class to be parametrized by the descendants of Joint. More...
class	Joint
	Ancestor of every joint, it is a lock joint. More...
class	BallJoint
	Ball joint. More...
class	HingeSlideJoint
class	ScrewJoint
class	JointInteractorExtension
	The interactor extension associated to the joint extension. More...
class	JointExtension
	Kinematic joint between two objects. More...
class	SessionPrm
	Define a session of interaction between an interactor and an interactive object. More...
Typedefs
typedef AverageT< float >	AverageFloat
	Average for float.
typedef AverageT< double >	AverageDouble
	Average for double.
typedef IntegratorT< int >	IntegratorInt
	Integrator for int.
typedef IntegratorT< float >	IntegratorFloat
	Integrator for float.
typedef IntegratorT< double >	IntegratorDouble
	Integrator for double.
typedef std::pair< Name, Name >	InteractorOutputsIndex
	Define what is a index of interactor outputs, a pair of ids.
typedef std::map< InteractorOutputsIndex, InteractorOutput * >	InteractorOutputsMap
	Define what is a map of interactor outputs.
typedef std::map< Name, SessionPrm * >	SessionsMap
	Define what is a map of interaction parameters.
typedef OBT::Singleton< OBT::PrototypeFactory< OMK::Name, JointCreator > >	JointFactory
	The factory of the extension.
Functions
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, OMK::Type::Transform)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, int)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, float)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SimpleConnectorT, bool)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, OMK::Type::Transform)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, int)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (SharedConnectorT, float)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, OMK::Type::Transform)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, int)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, float)
	REGISTER_TEMPLATE_CONNECTOR_FACTORY (AssociatedConnectorT, bool)
	REGISTER_CONVERTOR_FACTORY (Barycenter, OMK::Type::Transform, std::vector< OMK::Type::Transform >,"Barycenter")
	REGISTER_TEMPLATE_CONVERTOR_FACTORY (AverageFloat, float, std::vector< float >,"AverageFloat")
	REGISTER_TEMPLATE_CONVERTOR_FACTORY (AverageDouble, double, std::vector< double >,"AverageDouble")
	REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorInt, int, int,"IntegratorInt")
	REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorFloat, float, float,"IntegratorFloat")
	REGISTER_TEMPLATE_CONVERTOR_FACTORY (IntegratorDouble, double, double,"IntegratorDouble")
	REGISTER_JOINT_FACTORY (Joint,"Lock")
	REGISTER_JOINT_FACTORY (BallJoint,"Ball")
	REGISTER_JOINT_FACTORY (HingeSlideJoint,"Hinge")
	REGISTER_JOINT_FACTORY (ScrewJoint,"Screw")
	REGISTER_EXTENSION_FACTORY (JointExtension,"Joint")
SessionPrm &	getAccessibleParameters (SessionPrm &s)
SessionPrm &	controlTakeOverAndGetCurrentValues (SessionPrm &s)
SessionPrm &	controlRelease (SessionPrm &s)
SessionPrm &	controlFreeze (SessionPrm &s)
SessionPrm &	controlUnfreeze (SessionPrm &s)