BaseObjectData.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/


//=============================================================================
//
//  Types
//
//=============================================================================

#pragma once


//== INCLUDES =================================================================

#include <OpenFlipper/common/GlobalDefines.hh>
#include <OpenFlipper/common/BaseObject.hh>
#include <vector>
#include <ACG/Scenegraph/PickTarget.hh>
#include <ACG/Scenegraph/DrawModes.hh>

//== FORWARD Declarations to avoid gl qt collisions =================================================================

namespace ACG {
namespace SceneGraph {

class MaterialNode;
class QtTranslationManipulatorNode;
class SeparatorNode;
class BaseNode;
class BoundingBoxNode;
class StencilRefNode;
class ShaderNode;

}
}


//== TYPEDEFS FOR SCENEGRAPH ===============================================
typedef ACG::SceneGraph::MaterialNode                     MaterialNode;
typedef ACG::SceneGraph::QtTranslationManipulatorNode     QtTranslationManipulatorNode;
typedef ACG::SceneGraph::SeparatorNode                    SeparatorNode;
typedef ACG::SceneGraph::BaseNode                         BaseNode;
typedef ACG::SceneGraph::BoundingBoxNode                  BoundingBoxNode;
typedef ACG::SceneGraph::StencilRefNode                   StencilRefNode;

//== CLASS DEFINITION =========================================================

class DLLEXPORT BaseObjectData : public BaseObject
{

  friend class Core;

  Q_OBJECT
  
  public:

    BaseObjectData(const BaseObjectData& _object);

    BaseObjectData();

    virtual ~BaseObjectData();

  private:
    void initializeScenegraphNodes();

  //===========================================================================
  //===========================================================================

  public:
    virtual void cleanup();


    virtual void setName(QString _name );

  //===========================================================================
  //===========================================================================

  public :
    virtual void show();

    virtual void hide();

    virtual bool visible();

    virtual void visible(bool _visible);

    SeparatorNode* baseNode();

    virtual bool hasNode(BaseNode* _node);
    
    virtual BaseNode* primaryNode();
    
    QtTranslationManipulatorNode* manipulatorNode();

    virtual ACG::SceneGraph::ShaderNode* shaderNode();

    MaterialNode* materialNode();
    
    const MaterialNode* materialNode() const;
    
    BoundingBoxNode* boundingBoxNode();

    StencilRefNode* stencilRefNode();

    bool manipPlaced();

    void manipPlaced( bool _placed );

    void getBoundingBox(ACG::Vec3d& bbmin, ACG::Vec3d& bbmax);
    
    void setObjectDrawMode(const ACG::SceneGraph::DrawModes::DrawMode& _mode, const bool& _force = false);

  private :


    bool manipPlaced_;

    SeparatorNode*    rootNode_;

    SeparatorNode*    separatorNode_;

    QtTranslationManipulatorNode*  manipulatorNode_;

    MaterialNode*    materialNode_;

    BoundingBoxNode * boundingBoxNode_;

    StencilRefNode* stencilRefNode_;

  //===========================================================================
  //===========================================================================

  public :
    virtual bool picked( uint _node_idx );

    virtual void enablePicking( bool _enable );

    virtual bool pickingEnabled();

    virtual ACG::Vec3d refinePick(ACG::SceneGraph::PickTarget _pickTarget,
                                  const ACG::Vec3d _hitPoint,
                                  const ACG::Vec3d _start ,
                                  const ACG::Vec3d _dir,
                                  const unsigned int _targetIdx );

  //===========================================================================
  //===========================================================================

  protected:
    virtual void update(UpdateType _type = UPDATE_ALL );

  //===========================================================================
  //===========================================================================
  public:
    template< typename NodeT >
    bool addAdditionalNode(NodeT* _node , QString _pluginName, QString _nodeName , int _id = 0);

    bool hasAdditionalNode(QString _pluginName, QString _nodeName , int _id = 0);

    template< typename NodeT >
    bool getAdditionalNode(NodeT*& _node , QString _pluginName, QString _nodeName , int _id = 0 );

    template< typename NodeT >
    bool removeAdditionalNode(NodeT*& _node, QString _pluginName, QString _nodeName , int _id = 0 );
  private:
    std::vector< std::pair <BaseNode*,QString> > additionalNodes_;

};


//=============================================================================

#if defined(INCLUDE_TEMPLATES) && !defined(BASEOBJECTDATA_C)
#define BASEOBJECT_TEMPLATES
#include "BaseObjectDataT_impl.hh"
#endif