Object.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */


#ifndef ANA_OBJECT_OBJECT_H
#define ANA_OBJECT_OBJECT_H

#include <anatomist/config/anatomist_config.h>
#include <anatomist/color/Material.h>
#include <anatomist/observer/Observable.h>
#include <anatomist/observer/Observer.h>
#include <anatomist/object/objectmenu.h>
#include <cartobase/smart/rcptr.h>
#include <cartobase/object/object.h>
#include <aims/vector/vector.h>

#include <string>
#include <list>
#include <set>
#include <map>
#include <vector>


class ColorMap;
class Tree;

namespace aims
{
  class Quaternion;
}

namespace anatomist
{

  class AWindow;
  class Referential;
  class Geometry;
  class AObjectPalette;
  class MObject;
  class GLItem;
  class GLComponent;
  struct ViewState;
  typedef std::list<carto::rc_ptr<GLItem> > PrimList;
  class ObjectMenuRegistrerClass;


  struct AImage
  {
    int         width;
    int         height;
    int         depth;
    int         effectiveWidth;
    int         effectiveHeight;
    char        *data;
  };

  /*
     TODO:
     remove:
     MinT(), MaxT()
   */

  class ANATOMIST_API AObject : public Observable, public Observer
  {
  public:
    typedef std::set<MObject*> ParentList;

    enum ObjectType
    {
      VOLUME,
      BUCKET,
      FACET,
      TRIANG, 
      LIST, 
      VECTOR, 
      MAP, 
      SET, 
      GRAPH, 
      GRAPHOBJECT, 
      VOLSURF, 
      MULTISURF, 
      MULTIBUCKET, 
      MULTIVOLUME, 
      FUSION2D, 
      FUSION3D, 
      FASCICLE,
      FASCICLEGRAPH,
      TEXTURE,
      TEXSURFACE,
      FUSION2DMESH,
      VECTORFIELD,
      OTHER
    };

    typedef ObjectMenu* (*ObjectMenuRegistrerFunction)
      ( const AObject* objtype, ObjectMenu* menu );

    AObject( const std::string & filename = "" );
    virtual ~AObject();

    virtual AObject* clone( bool shallow = true );

    virtual const GLComponent* glAPI() const { return 0; }
    virtual GLComponent* glAPI() { return 0; }
    virtual const MObject* mObjectAPI() const { return 0; }
    virtual MObject* mObjectAPI() { return 0; }

    int type() const      { return( _type ); }   
    void setType(int type) { _type = type; };
    int id() const        { return( _id ); }
    std::string name() const     { return( _name ); }
    std::string fileName() const { return( _filename ); }
    void setName( const std::string & n );
    void setFileName( const std::string & filename );
    void setId( int id );
    virtual int isMultiObject() const { return( false ); }

    virtual float MinT() const;
    virtual float MaxT() const;

    virtual bool boundingBox2D( std::vector<float> & bmin,
                                std::vector<float> & bmax ) const;

    virtual bool boundingBox( std::vector<float> & bmin,
                              std::vector<float> & bmax ) const;

    virtual bool render( PrimList &, const ViewState & );
    virtual std::vector<float> voxelSize() const;
    virtual void setVoxelSize( const std::vector<float> & ) {}
    virtual void internalUpdate();

    virtual void adjustPalette() {}
    virtual AObjectPalette* palette() { return( _palette ); }
    virtual const AObjectPalette* palette() const { return( _palette ); }
    virtual void setPalette( const AObjectPalette & palette );
    virtual const AObjectPalette* getOrCreatePalette() const;
    virtual void createDefaultPalette( const std::string & name = "" );

    virtual void SetMaterial( const Material & mat );
    virtual Material & GetMaterial() { return _material; }
    virtual const Material & material() const
    { return const_cast<AObject *>(this)->GetMaterial(); }

    Referential* getReferential() const;
    AObject *referentialInheritance() const;
    virtual void setReferentialInheritance( AObject* ao );
    virtual void setReferential( Referential* ref );
    virtual AObject* fallbackReferentialInheritance() const;
    const Referential* previousReferential() const;

    virtual Tree* optionTree() const;
    virtual ObjectMenu* optionMenu() const;
    int InMemory() const { return _inMemory; }
    int Visible() const { return _visible; }
    void SetVisibility( int v ) { _visible = v; }
    ParentList & Parents() { return _parents; }
    ParentList & parents() { return _parents; }
    const ParentList & parents() const { return _parents; }
    virtual void RegisterParent( MObject *pob ) { _parents.insert( pob ); }
    virtual void UnregisterParent( MObject *pob ) { _parents.erase( pob ); }
    const std::set<AWindow*> & WinList() { return _winList; }
    virtual void registerWindow(AWindow* window);
    virtual void unregisterWindow(AWindow* window);
    virtual bool Is2DObject() = 0;
    virtual bool Is3DObject() = 0;
    virtual bool textured2D() const { return false; }
    virtual bool isTransparent() const;
    virtual bool renderingIsObserverDependent() const;
    virtual int CanBeDestroyed();

    virtual void setReferenceChanged();
    bool hasReferenceChanged() const;
    virtual void setInternalsChanged();
    virtual void clearHasChangedFlags() const;

    virtual AObject* objectAt( const std::vector<float> & pos, float tol = 0 );
    virtual AObject* objectAt( const std::vector<float> & pos,
                               float tol, const Referential* orgref,
                               const Point3df & orggeom );

    virtual void setGeomExtrema() {}
    virtual void SetExtrema() {}
    virtual bool hasTexture() const { return( false ); }
    virtual unsigned dimTexture() const { return( 1 ); }
    virtual float mixedTexValue( const std::vector<float> & pos,
                                 const Referential* orgRef ) const;
    virtual float mixedTexValue( const std::vector<float> & pos ) const;
    virtual std::vector<float> texValues( const std::vector<float> & pos,
                                          const Referential* orgRef ) const;
    virtual std::vector<float>
    texValues( const std::vector<float> & pos ) const;

    virtual bool loadable() const { return false; }
    virtual bool savable() const { return false; }
    virtual bool reload( const std::string & filename );

    virtual std::string objectFullTypeName(void) const
    { return objectTypeName(_type); };
    virtual bool save( const std::string & filename );
    virtual bool printTalairachCoord( const Point3df &, 
                                      const Referential* ) const
    { return( false ); }
    void setHeaderOptions();
    virtual void setProperties( carto::Object options );
    virtual void storeHeaderOptions();
    virtual carto::Object makeHeaderOptions() const;
    long loadDate() const;
    void setLoadDate( long t );
    virtual void update( const Observable *observable, void *arg );
    bool isCopy() const;
    void setCopyFlag( bool x = true );
    virtual std::string toolTip() const;

    static std::list<AObject *> load( const std::string & filename );
    static bool reload( AObject* object, bool onlyoutdated = false );
    static int registerObjectType( const std::string & id );
    static std::string objectTypeName( int type );
    static void setObjectMenu(std::string type, carto::rc_ptr<ObjectMenu> om)
    {
      _objectmenu_map[type] = om;
    }
    static carto::rc_ptr<ObjectMenu> getObjectMenu(std::string type)
    {
      return _objectmenu_map[type];
    }
    static std::map<std::string, carto::rc_ptr<ObjectMenu> >
        &getObjectMenuMap()
    {
      return _objectmenu_map;
    }
    static void addObjectMenuRegistration( ObjectMenuRegistrerFunction );
    static void addObjectMenuRegistration( ObjectMenuRegistrerClass * );

    static void cleanStatic();

    carto::Object aimsMeshFromGLComponent();

  protected:
    const PrimList & primitives() const;
    PrimList & primitives();
    virtual void cleanup();
    virtual void clearReferentialInheritance();
    AObject *& _referentialInheritance();
    virtual void unregisterObservable( Observable * );
    AObject( const AObject & );

    int                 _type;
    int                 _id;
    std::string         _name;
    std::string         _filename;

    std::set<AWindow*>  _winList;
    int                 _inMemory;
    int                 _visible;
    ParentList          _parents;

    Material            _material;
    Referential         *_referential;
    mutable bool        _referenceHasChanged;

    mutable AObjectPalette      *_palette;

    static std::map<std::string, int>   _objectTypes;
    static std::map<int,std::string>    _objectTypeNames;

    static std::map<std::string, carto::rc_ptr<ObjectMenu> >
        _objectmenu_map;

    friend class StaticInitializers;

  private:
    struct Private;
    Private     *d;
  };

}


inline float
anatomist::AObject::mixedTexValue( const std::vector<float> & ) const
{
  return 0;
}


inline std::vector<float> 
anatomist::AObject::texValues( const std::vector<float> & ) const
{
  std::vector<float> t;
  return t;
}


namespace carto
{
  DECLARE_GENERIC_OBJECT_TYPE( anatomist::AObject * )
  DECLARE_GENERIC_OBJECT_TYPE( std::set<anatomist::AObject *> )
  DECLARE_GENERIC_OBJECT_TYPE( std::vector<anatomist::AObject *> )
  DECLARE_GENERIC_OBJECT_TYPE( std::list<anatomist::AObject *> )
  DECLARE_GENERIC_OBJECT_TYPE( carto::shared_ptr<anatomist::AObject> )
}

#endif