CShapeLine.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: 2164 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CShapeLineH
#define CShapeLineH
//------------------------------------------------------------------------------
#include "world/CGenericObject.h"
#include "materials/CMaterial.h"
//------------------------------------------------------------------------------

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

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

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

public:

    cShapeLine();

    cShapeLine(const cVector3d& a_pointA, const cVector3d& a_pointB);

    cShapeLine(cGenericObject* a_objectA, cGenericObject* a_objectB);

    cShapeLine(cGenericObject* a_objectA, const cVector3d& a_pointA,
        cGenericObject* a_objectB, const cVector3d& a_pointB);

    virtual ~cShapeLine() {};


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

public:

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

    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 MEMBERS: (cShapeLine)
    //--------------------------------------------------------------------------

public:

    cVector3d m_pointA;

    cVector3d m_pointB;

    cColorf m_colorPointA;

    cColorf m_colorPointB;

    cGenericObject* m_objectA;

    cGenericObject* m_objectB;


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

protected:

    virtual void render(cRenderOptions& a_options);

    virtual void updateBoundaryBox();

    virtual void scaleObject(const double& a_scaleFactor);

    virtual void computeLocalInteraction(const cVector3d& a_toolPos,
        const cVector3d& a_toolVel,
        const unsigned int a_IDN);

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


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

protected:

    void copyShapeLineProperties(cShapeLine* a_obj,
        const bool a_duplicateMaterialData,
        const bool a_duplicateTextureData, 
        const bool a_duplicateMeshData,
        const bool a_buildCollisionDetector);

    // Initialize line object.
    void reset();

    // Update position of line extremities.
    void updateLinePoints();


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    double m_lineWidth;

    GLint m_stippleFactor;

    GLushort m_stipplePattern;

    // Point A in local coordinates
    cVector3d m_linePointA;

    // Point A in local coordinates
    cVector3d m_linePointB;

};

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

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