OMK::PreOffsetExtension Class Reference
[Extensions]

Extension to add an offset to a Transform attribute of the object. More...

#include <OMKOffsetExtension.h>

Inheritance diagram for OMK::PreOffsetExtension:

[legend]Collaboration diagram for OMK::PreOffsetExtension:

[legend]List of all members.

Public Member Functions
	DECLARE_EXTENSION_FACTORY (PreOffsetExtension)
	Factory and constructor/destructor.
Protected Member Functions
Configuration loaders
See How to configure an extension ? for details.
virtual bool	loadExtensionParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of Extension.
Computation
See Computing of simulated object for details.
virtual void	preComputeParameters ()
	Offsets the associated attribute.
Protected Attributes
IAccessorT< OMK::Type::Transform > *	_attributeAccessor
	The associated attribute.
AttributeT< OMK::Type::Transform >	_offset
	The offset attribute.
bool	_post
	Flag to define pre or post-computing.
bool	_ignoreRotate
	Flag to define if the rotate is disable, false by default.
bool	_ignoreScale
	Flag to define if the scale is disable, false by default.

---

Detailed Description

Extension to add an offset to a Transform attribute of the object.

Date:

2007-03-15

Author:

Benoît Chanclou

Module description :

Defines an offset attribute for the object. The name of the attribute will be the same as the one of the extension. This attribute can be connected to the output of an another object. For this use OffsetConnect.

The offset can be done in the pre-compute or the post-compute step according to creation id. To choose one or the other use PreOffset (uses to offset an input) or PostOffest (uses to offset an output), as class's name in the configuration.

• Attribute The name of the attribute to offset
• Offset, OffsetConnect, OffsetSetByEvent and so on, the Offset attribute parameters.

Example:

myObject
{ 
  Class MyObject // with a "Position" attribute
  Extensions
  {     
    offset
    {
      Class PostOffset // or PreOffset
      Attribute Position // the name of the attribute to offset
      Offset [[0 0 -100]] // the offset value (it is optional, the default is identity)
      OffsetConnect [anotherObject aTransformOutput]
    }
  }
}
 *

Definition at line 49 of file OMKOffsetExtension.h.

---

Member Function Documentation

OMK::PreOffsetExtension::DECLARE_EXTENSION_FACTORY

(

PreOffsetExtension

)

Factory and constructor/destructor.

See Extension feature

bool PreOffsetExtension::loadExtensionParameters

(

const ConfigurationParameterDescriptor *

node

)

[protected, virtual]

Configuration parameters loader of Extension.

It retrieves, in the extension configuration, the offset and the name of the attribute to ofset.

Reimplemented from OMK::Extension.

Definition at line 30 of file OMKOffsetExtension.cpp.

References _attributeAccessor, _ignoreRotate, _ignoreScale, _offset, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::ParametersAccessor::get(), and OMK::IAttributeBaseT< PrmType >::loadParameters().

{
  // Retrieve the visual objects
  bool ok = true ;
  // Offset value
  _offset.loadParameters( node, "Offset" ) ;
  // Attribute to offset
  Name attributeName ;
  ok = ok && ParametersAccessor::get( node, "Attribute", attributeName, _owner ) ;
  _attributeAccessor =
    ok ? _owner->getBaseAttribute< OMK::Type::Transform >( attributeName ) : 0 ;
  ok = ok && _attributeAccessor != 0 ;
  ParametersAccessor::get( node, "IgnoreRotate", _ignoreRotate ) ;
  ParametersAccessor::get( node, "IgnoreScale", _ignoreScale ) ;

  return ok ;
}

void PreOffsetExtension::preComputeParameters

(

)

[protected, virtual]

Offsets the associated attribute.

Only in for the pre compute version.

Reimplemented from OMK::Extension.

Reimplemented in OMK::PostOffsetExtension.

Definition at line 49 of file OMKOffsetExtension.cpp.

References _attributeAccessor, _ignoreRotate, _ignoreScale, _offset, OMK::ExtensionT< SimulatedObjectType >::_owner, OMK::debugMsg(), OMK::IAttributeT< PrmType, ModelType, AccessorType >::get(), OMK::IAccessorT< T >::get(), OMASSERTM, and OMK::IAccessorT< T >::set().

Referenced by OMK::PostOffsetExtension::postComputeParameters().

{
  OMASSERTM( _attributeAccessor,
             debugMsg( this, _owner ) << "Must be initalised !" ) ;

  Transform result( _attributeAccessor->get() ) ;
  Transform offset( _offset.get() ) ;
  Transform value( _attributeAccessor->get() ) ;
  if( offset.isIdentity() )
  {
    result = value ;
  }
  else if( value.isIdentity() )
  {
    result = offset ;
  }
  else
  {
    Wm4::Matrix3f rotate( Wm4::Matrix3f::IDENTITY ) ;
    if( !_ignoreRotate ) 
    {
      result.setRotate( offset.getRotate() * value.getRotate() ) ;
      rotate = offset.getRotate() ;
    }

    if( _ignoreScale )
    {
      result.setTranslate( rotate * value.getTranslate() +
                           offset.getTranslate() ) ;
    }
    else
    {
      if( offset.isUniformScale() )
      {
        result.setTranslate( offset.getUniformScale() *
                             ( rotate * value.getTranslate() ) +
                             offset.getTranslate() ) ;

        if ( value.isUniformScale() )
        {
          result.setUniformScale( offset.getUniformScale() *
                                  value.getUniformScale() ) ;
        }
        else
        {
          result.setScale( offset.getUniformScale() * value.getScale() ) ;
        }
      }
      else
      {
        Wm4::Vector3f v0_translate( rotate * value.getTranslate() ) ;
        Wm4::Vector3f v1_translate( offset.getScale()[0] * v0_translate[0],
                                    offset.getScale()[1] * v0_translate[1],
                                    offset.getScale()[2] * v0_translate[2] ) ;
        result.setTranslate( v1_translate + offset.getTranslate() ) ;

        if ( value.isUniformScale() )
        {
          result.setScale( offset.getScale() * value.getUniformScale() ) ;
        }
        else
        {
          Wm4::Vector3f v0_scale( rotate * value.getScale() ) ;
          Wm4::Vector3f v1_scale( offset.getScale()[0] * v0_scale[0],
                                  offset.getScale()[1] * v0_scale[1],
                                  offset.getScale()[2] * v0_scale[2] ) ;
          result.setScale( v1_scale ) ;
        }
      }
    }
  }

  _attributeAccessor->set( result ) ;
}

---

Member Data Documentation

IAccessorT< OMK::Type::Transform >* OMK::PreOffsetExtension::_attributeAccessor [protected]

The associated attribute.

It must be defined by the configuration parameter named Attribute.

Definition at line 74 of file OMKOffsetExtension.h.

Referenced by loadExtensionParameters(), and preComputeParameters().

AttributeT< OMK::Type::Transform > OMK::PreOffsetExtension::_offset [protected]

The offset attribute.

It can be defined by the configuration parameter named Offset.

Definition at line 77 of file OMKOffsetExtension.h.

Referenced by loadExtensionParameters(), and preComputeParameters().

bool OMK::PreOffsetExtension::_post [protected]

Flag to define pre or post-computing.

Definition at line 79 of file OMKOffsetExtension.h.

bool OMK::PreOffsetExtension::_ignoreRotate [protected]

Flag to define if the rotate is disable, false by default.

Definition at line 81 of file OMKOffsetExtension.h.

Referenced by loadExtensionParameters(), and preComputeParameters().

bool OMK::PreOffsetExtension::_ignoreScale [protected]

Flag to define if the scale is disable, false by default.

Definition at line 83 of file OMKOffsetExtension.h.

Referenced by loadExtensionParameters(), and preComputeParameters().

---