CMultiSegment.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 CMultiSegmentH
#define CMultiSegmentH
//------------------------------------------------------------------------------
#include "world/CGenericObject.h"
#include "materials/CMaterial.h"
#include "materials/CTexture2d.h"
#include "graphics/CColor.h"
//------------------------------------------------------------------------------
#include <vector>
#include <list>
//------------------------------------------------------------------------------

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

//------------------------------------------------------------------------------
class cWorld;
//------------------------------------------------------------------------------

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

//------------------------------------------------------------------------------
class cVertexArray;
typedef std::shared_ptr<cVertexArray> cVertexArrayPtr;

class cSegmentArray;
typedef std::shared_ptr<cSegmentArray> cSegmentArrayPtr;
//------------------------------------------------------------------------------

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

    cMultiSegment();

    virtual ~cMultiSegment();


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

public:

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


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - VERTICES
    //--------------------------------------------------------------------------

public:


    unsigned int newVertex(const double a_x = 0.0, 
                           const double a_y = 0.0, 
                           const double a_z = 0.0);

    unsigned int newVertex(const cVector3d& a_pos, 
                           const cColorf& a_color = cColorf(0,0,0,1));

    inline unsigned int getNumVertices() const { return (unsigned int)(m_vertices->getNumElements()); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - SEGMENTS
    //--------------------------------------------------------------------------

public:

    unsigned int newSegment(const unsigned int a_indexVertex0,
                            const unsigned int a_indexVertex1);

    unsigned int newSegment(const cVector3d& a_vertex0 = cVector3d(0,0,0),
                            const cVector3d& a_vertex1 = cVector3d(0,0,0),
                            const cColorf& a_colorVertex0 = cColorf(0,0,0,1),
                            const cColorf& a_colorVertex1 = cColorf(0,0,0,1));

    bool removeSegment(const unsigned int a_index);

    unsigned int getNumSegments();

    void clear();


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

public:

    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 markForUpdate(const bool a_affectChildren = false);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - LINE GRAPHIC PROPERTIES
    //--------------------------------------------------------------------------

public:

    void setLineColor(const cColorf& a_color);

    inline void setLineWidth(const double a_lineWidth) { m_lineWidth = fabs(a_lineWidth); }

    inline double getLineWidth() const { return (m_lineWidth); }

    void setLineStipple(const GLint a_stippleFactor, const GLushort a_stipplePattern);

    GLint getLineStippleFactor() { return (m_stippleFactor); }

    GLushort  getLineStipplePattern() { return (m_stipplePattern); }


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

public:

    virtual void createBruteForceCollisionDetector();

    virtual void createAABBCollisionDetector(const double a_radius);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - GEOMETRY:
    //--------------------------------------------------------------------------

public:

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

    virtual void offsetVertices(const cVector3d& a_offset, 
                                const bool a_updateCollisionDetector = true);

    virtual cVector3d getCenterOfMass();


    //--------------------------------------------------------------------------
    // PROTECTED METHODS - INTERNAL
    //--------------------------------------------------------------------------

protected:

    virtual void render(cRenderOptions& a_options);

    virtual void renderSegments(cRenderOptions& a_options);

    virtual void updateGlobalPositions(const bool a_frameOnly);

    virtual void updateBoundaryBox();

    void copyMultiSegmentProperties(cMultiSegment* a_obj, 
        const bool a_duplicateMaterialData = false,
        const bool a_duplicateTextureData = false, 
        const bool a_duplicateMeshData = false,
        const bool a_buildCollisionDetector = false);

    virtual void scaleObject(const double& a_scaleFactor) { scaleXYZ(a_scaleFactor, a_scaleFactor, a_scaleFactor); }


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS - DISPLAY PROPERTIES:
    //--------------------------------------------------------------------------

protected:

    bool m_showSegments;

    double m_lineWidth;

    GLint m_stippleFactor;

    GLushort m_stipplePattern;


    //--------------------------------------------------------------------------
    // PUBLIC MEMBERS - SEGMENT AND VERTEX DATA:
    //--------------------------------------------------------------------------

public:

    cVertexArrayPtr m_vertices;

    cSegmentArrayPtr m_segments;
};

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

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