CMultiMesh.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * 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.

    * Neither the name of CHAI3D 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 OWNER 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. 

    \author    <http://www.chai3d.org>
    \author    Francois Conti
    \version   3.2.0 $Rev: 2161 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CMultiMeshH
#define CMultiMeshH
//------------------------------------------------------------------------------
#include "world/CMesh.h"
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

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

//==============================================================================
//==============================================================================
class cMultiMesh : public cGenericObject
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cMultiMesh();

    virtual ~cMultiMesh();


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - GENERAL:
    //--------------------------------------------------------------------------

public:

    virtual void setEnabled(bool a_enabled,
                            const bool a_affectChildren = false);

    virtual cMultiMesh* copy(const bool a_duplicateMaterialData = false,
                             const bool a_duplicateTextureData = false, 
                             const bool a_duplicateMeshData = false,
                             const bool a_buildCollisionDetector = true);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - HAPTIC PROPERTIES:
    //-----------------------------------------------------------------------

public:

    virtual void setHapticEnabled(const bool a_hapticEnabled, 
                                  const bool a_affectChildren = false);

    virtual void setStiffness(const double a_stiffness, 
                              const bool a_affectChildren = false);

    virtual void setFriction(double a_staticFriction, 
                             double a_dynamicFriction, 
                             const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - GRAPHIC PROPERTIES:
    //-----------------------------------------------------------------------

public:

    virtual void setShowEnabled(const bool a_show, const bool a_affectChildren = false);

    virtual void setWireMode(const bool a_showWireMode, 
        const bool a_affectChildren = true);

    virtual void setUseCulling(const bool a_useCulling, 
        const bool a_affectChildren=true);

    virtual void setUseTransparency(const bool a_useTransparency, const bool a_affectChildren = false);

    virtual void setTransparencyLevel(const float a_level,
        const bool a_applyToVertices = false,
        const bool a_applyToTextures = false,
        const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - DISPLAY LISTS:
    //-----------------------------------------------------------------------

public:

    virtual void setUseDisplayList(const bool a_useDisplayList, const bool a_affectChildren = false);

    virtual void markForUpdate(const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - MATERIAL PROPERTIES:
    //-----------------------------------------------------------------------

public:

    virtual void setUseMaterial(const bool a_useMaterial, const bool a_affectChildren = true);

    virtual void setMaterial(cMaterialPtr a_material, const bool a_affectChildren = false);

    virtual void setMaterial(cMaterial& a_material, const bool a_affectChildren = false);

    virtual void backupMaterialColors(const bool a_affectChildren = false);

    virtual void restoreMaterialColors(const bool a_affectChildren = false);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - TEXTURE PROPERTIES:
    //-----------------------------------------------------------------------

public:

    virtual void setUseTexture(const bool a_useTexture, const bool a_affectChildren = true);

    virtual void setTexture(cTexture1dPtr, const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - SHADERS:
    //-----------------------------------------------------------------------

public:

    virtual void setShaderProgram(cShaderProgramPtr a_shaderProgram, const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - BOUNDARY BOX:
    //-----------------------------------------------------------------------

public:

    virtual void setShowBoundaryBox(const bool a_showBoundaryBox, const bool a_affectChildren = false);


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - COLLISION DETECTION:
    //-----------------------------------------------------------------------

public:

    virtual void deleteCollisionDetector(const bool a_affectChildren = false);

    virtual bool computeCollisionDetection(const cVector3d& a_segmentPointA,
                                           const cVector3d& a_segmentPointB,
                                           cCollisionRecorder& a_recorder,
                                           cCollisionSettings& a_settings);

    virtual void setShowCollisionDetector(const bool a_showCollisionDetector, 
                                          const bool a_affectChildren = false);

    virtual void setCollisionDetectorProperties(unsigned int a_displayDepth, 
                                                cColorf& a_color, 
                                                const bool a_affectChildren = false);

    virtual void createBruteForceCollisionDetector();

    virtual void createAABBCollisionDetector(const double a_radius);


    //-----------------------------------------------------------------------
    // PUBLIC VIRTUAL METHODS - INTERACTIONS
    //-----------------------------------------------------------------------

public:

    virtual cVector3d computeInteractions(const cVector3d& a_toolPos,
        const cVector3d& a_toolVel,
        const unsigned int a_IDN,
        cInteractionRecorder& a_interactions);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - MESH PRIMITIVES:
    //--------------------------------------------------------------------------

public:

    cMesh* newMesh();

    bool addMesh(cMesh* a_mesh);

    bool removeMesh(cMesh* a_mesh);

    bool removeAllMesh();

    bool deleteMesh(cMesh* a_mesh);

    bool deleteAllMeshes();

    int getNumMeshes();

    cMesh* getMesh(unsigned int a_index);

    void convertToSingleMesh(cMesh* a_mesh);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - VERTICES
    //--------------------------------------------------------------------------
    
public:

    bool getVertex(const unsigned int a_index, cMesh*& a_mesh, unsigned int& a_vertexIndex);

    cVector3d getVertexPos(unsigned int a_index);

    unsigned int getNumVertices() const;

    virtual void setUseVertexColors(const bool a_useColors, const bool a_affectChildren=true);

    void setVertexColor(const cColorf& a_color);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - TRIANGLES
    //--------------------------------------------------------------------------

public:

    bool getTriangle(const unsigned int a_index, cMesh*& a_mesh, unsigned int& a_triangleIndex);

    unsigned int getNumTriangles() const;

    void clear();

    void setShowTriangles(const bool a_showTriangles);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - EDGES
    //--------------------------------------------------------------------------

public:

    void computeAllEdges(double a_angleThresholdDeg = 40.0);

    void clearAllEdges();

    void setShowEdges(const bool a_showEdges);

    void setEdgeProperties(const double a_width, 
                           const cColorf& a_color);

    void setEdgeLineWidth(const double a_width);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - SURFACE NORMALS
    //--------------------------------------------------------------------------

public:

    void setShowNormals(const bool& a_showNormals);

    void setNormalsProperties(const double a_length, const cColorf& a_color);

    void setNormalsLength(const double a_length);

    void computeAllNormals();

    void reverseAllNormals();

    void computeBTN();

    void setShowTangents(const bool a_showTangents);


    //--------------------------------------------------------------------------
    // PUBLIC VIRTUAL METHODS - FILES:
    //--------------------------------------------------------------------------

public:

    virtual bool loadFromFile(std::string a_filename);

    virtual bool saveToFile(std::string a_filename);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - SCALING:
    //--------------------------------------------------------------------------

public:

    virtual void scale(const double& a_scaleFactor, const bool a_affectChildren = true);

    void scaleXYZ(const double a_scaleX, const double a_scaleY, const double a_scaleZ);


    //--------------------------------------------------------------------------
    // PROTECTED METHODS:
    //--------------------------------------------------------------------------

protected:

    virtual void render(cRenderOptions& a_options);

    virtual void updateGlobalPositions(const bool a_frameOnly);

    virtual void updateBoundaryBox();

    void copyMultiMeshProperties(cMultiMesh* a_obj,
        const bool a_duplicateMaterialData,
        const bool a_duplicateTextureData, 
        const bool a_duplicateMeshData,
        const bool a_buildCollisionDetector);


    //-----------------------------------------------------------------------
    // PUBLIC MEMBERS
    //-----------------------------------------------------------------------

public:

    std::vector<cMesh*> *m_meshes;

};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------