Spatial.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2015 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 *
 */

#ifndef SPATIAL_H_6014714286
#define SPATIAL_H_6014714286

#include <Carna/Carna.h>
#include <Carna/base/math.h>
#include <Carna/base/noncopyable.h>
#include <functional>

namespace Carna
{

namespace base
{



// ----------------------------------------------------------------------------------
// Spatial
// ----------------------------------------------------------------------------------

class CARNA_LIB Spatial
{

    NON_COPYABLE

    Node* myParent;
    math::Matrix4f myWorldTransform;
    const void* myUserData;
    bool movable;
    std::string myTag;

public:

    EIGEN_MAKE_ALIGNED_OPERATOR_NEW

    explicit Spatial( const std::string& tag = "" );
    
    virtual ~Spatial();
    
    typedef std::function< void( Spatial& ) > MutableVisitor;
    
    typedef std::function< void( const Spatial& ) > ImmutableVisitor;
    
    bool hasParent() const;

    Spatial* detachFromParent();

    void updateParent( Node& parent );
    
    Node& parent();
    
    const Node& parent() const;

    Node& findRoot();
    
    const Node& findRoot() const;
    
    math::Matrix4f localTransform;
    
    virtual void updateWorldTransform();
    
    const math::Matrix4f& worldTransform() const;

    template< typename UserDataType >
    void setUserData( const UserDataType& userData );
    
    void removeUserData();

    bool hasUserData() const;

    template< typename UserDataType >
    const UserDataType& userData() const;

    void setMovable( bool movable );
    
    bool isMovable() const;
    
    virtual void invalidate();
    
    void setTag( const std::string& tag );
    
    const std::string& tag() const;

}; // Spatial


template< typename UserDataType >
void Spatial::setUserData( const UserDataType& userData )
{
    myUserData = &userData;
    CARNA_ASSERT( hasUserData() );
}


template< typename UserDataType >
const UserDataType& Spatial::userData() const
{
    CARNA_ASSERT( hasUserData() );
    return *static_cast< const UserDataType* >( myUserData );
}



}  // namespace Carna :: base

}  // namespace Carna

#endif // SPATIAL_H_6014714286