OMK::Orbit Class Reference
[Simulated ojects]

This Simulated object defines a position which moves in the space. More...

#include <OMKOrbit.h>

Inheritance diagram for OMK::Orbit:

[legend]Collaboration diagram for OMK::Orbit:

[legend]List of all members.

Protected Member Functions
virtual void	computeParameters ()
	This part of the compute methods computes the associated data.
virtual bool	loadParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of Orbit.
Protected Attributes
float	_angle
	The position on the orbit.
float	_planetAngle
Wm4::Vector3f	_planetAxis
	Reference axis for orientation.
OMK::AttributeT< float >	_speed
OMK::AttributeT< float >	_radius
OMK::AttributeT< float >	_period
	The period of the orbit.
OMK::AttributeT< float >	_planetPeriod
	The period of the rotation.
Private Member Functions
	DECLARE_OBJECT_FACTORY (Orbit)

---

Detailed Description

This Simulated object defines a position which moves in the space.

Configuration parameters are :

• Radius
• Period
• PlanetPeriod
• Position a transform, the initial position, only the rotate and the scale will be used, the translate is given by the first Targets.

All the parameters have default values.

Example:

object1
{
  Class Orbit
  Scheduling
  {
    ...
  }
  Extensions
  {
    ...
  }
  UserParams
  {
    Position [[0 0 0 ][1.57 1.57 0]]
  }
}

Definition at line 43 of file OMKOrbit.h.

---

Member Function Documentation

OMK::Orbit::DECLARE_OBJECT_FACTORY

(

Orbit

)

[private]

void Orbit::computeParameters

(

)

[protected, virtual]

This part of the compute methods computes the associated data.

The inputs and outputs should work with associated data, you should use these associated data.

Reimplemented from OMK::ExtensibleSimulatedObject.

Definition at line 47 of file OMKOrbit.cpp.

References _angle, _period, _planetAngle, _planetAxis, _planetPeriod, OMK::SimplePoint::_position, _radius, _speed, OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), OMK::Type::Transform::getRotate(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::set(), OMK::Type::Transform::setRotate(), and OMK::Type::Transform::setTranslate().

{
  // Get the increment
  if ( 1.0f <= _angle ) 
  { // step > 0
    _angle = 0.0 ;
  }
  else if( _period.get() != 0.0f )
  {
    _angle += 1.0f / _period.get() * _speed.get() ;
  }
  if ( 1.0f <= _planetAngle ) 
  { // step > 0
    _planetAngle = 0.0 ;
  }
  else if( _planetPeriod.get() != 0.0f )
  {
    _planetAngle += 1.0f / _planetPeriod.get() * _speed.get() ;
  }
  
  // Get the translate and the rotate
  OMK::Type::Transform position ;
  Wm4::Vector3f orientation ;
  position.setTranslate( Wm4::Vector3f( _radius.get() * Wm4::Math<float>::Cos( Wm4::Math<float>::TWO_PI * _angle ),
                                        _radius.get() * Wm4::Math<float>::Sin( Wm4::Math<float>::TWO_PI * _angle ), 
                                        0.0f ) ) ;

  // Calculate the orientation
  Wm4::Matrix3f rotationMatrix( _planetAxis, Wm4::Math<float>::TWO_PI * _planetAngle ) ;
  position.setRotate( position.getRotate() * rotationMatrix ) ;

  // Set the new position
  _position.set( position ) ;
}

bool Orbit::loadParameters

(

const ConfigurationParameterDescriptor *

node

)

[protected, virtual]

Configuration parameters loader of Orbit.

Parameters:

[in]

node

the root node of the configuration parameter.

Returns:

true if all needed parameters can be read.

Reads in the configuration node the values to set the attributs.

Reimplemented from OMK::ExtensibleSimulatedObject.

Definition at line 37 of file OMKOrbit.cpp.

References _planetAxis, OMK::SimplePoint::_position, OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), OMK::ExtensibleSimulatedObject::loadParameters(), and OMK::IAttributeT< PrmType, ModelType, AccessorType >::setValueToOutput().

{
  SimplePoint::loadParameters( node ) ;
  _planetAxis = _position.get().getDirection() ;
  _position.setValueToOutput() ;

  return true ; 
}

---

Member Data Documentation

float OMK::Orbit::_angle [protected]

The position on the orbit.

Its value is in the set [0, 1[

Definition at line 58 of file OMKOrbit.h.

Referenced by computeParameters().

float OMK::Orbit::_planetAngle [protected]

Definition at line 59 of file OMKOrbit.h.

Referenced by computeParameters().

Wm4::Vector3f OMK::Orbit::_planetAxis [protected]

Reference axis for orientation.

Definition at line 61 of file OMKOrbit.h.

Referenced by computeParameters(), and loadParameters().

OMK::AttributeT< float > OMK::Orbit::_speed [protected]

Definition at line 63 of file OMKOrbit.h.

Referenced by computeParameters().

OMK::AttributeT< float > OMK::Orbit::_radius [protected]

Definition at line 64 of file OMKOrbit.h.

Referenced by computeParameters().

OMK::AttributeT< float > OMK::Orbit::_period [protected]

The period of the orbit.

Definition at line 66 of file OMKOrbit.h.

Referenced by computeParameters().

OMK::AttributeT< float > OMK::Orbit::_planetPeriod [protected]

The period of the rotation.

Definition at line 68 of file OMKOrbit.h.

Referenced by computeParameters().

---