CPanel.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: 2167 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CPanelH
#define CPanelH
//------------------------------------------------------------------------------
#include "widgets/CGenericWidget.h"
//------------------------------------------------------------------------------

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

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

//==============================================================================
//==============================================================================
class cPanel : public cGenericWidget
{    
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cPanel();

    virtual ~cPanel() {};


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

public:

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

    virtual void set(const double& a_width, 
        const double& a_height,
        const double& a_radiusTopLeft = 0,
        const double& a_radiusTopRight = 0,
        const double& a_radiusBottomLeft = 0,
        const double& a_radiusBottomRight = 0);

    virtual void setSize(const double& a_width, 
        const double& a_height);

    virtual void setCornerRadius(const double& a_radiusTopLeft = 0,
        const double& a_radiusTopRight = 0,
        const double& a_radiusBottomLeft = 0,
        const double& a_radiusBottomRight = 0);

    virtual void setColor(const cColorf& a_panelColor);

    virtual void setCornerColors(const cColorf& a_panelColorTopLeft, 
        const cColorf& a_panelColorTopRight, 
        const cColorf& a_panelColorBottomLeft, 
        const cColorf& a_panelColorBottomRight);

    virtual void setPanelColorVerticalGradient(cColorf a_topColor, 
        cColorf a_bottomColor);

    virtual void setHorizontalLinearGradient(cColorf a_leftColor, 
        cColorf a_rightColor);

    inline cColorf getColorTopLeft() const { return (m_panelColorTopLeft); }

    inline cColorf getColorTopRight() const { return (m_panelColorTopRight); }

    inline cColorf getColorBottomLeft() const { return (m_panelColorBottomLeft); }

    inline cColorf getColorBottomRight() const { return (m_panelColorBottomRight); }

    void setShowPanel(const bool a_showPanel) { m_showPanel = a_showPanel; updatePanelMesh(); }

    bool getShowPanel() { return (m_showPanel); }


    //--------------------------------------------------------------------------
    // VIRTUAL PUBLIC METHODS: MARGINS
    //--------------------------------------------------------------------------

public:

    virtual void setMargins(const double a_marginTop,
        const double a_marginBottom,
        const double a_marginLeft,
        const double a_marginRight);

    virtual void setMarginTop(const double a_marginTop);

    virtual double getMarginTop() { return (m_marginTop); }

    virtual void setMarginBottom(const double a_marginBottom);

    virtual double getMarginBottom() { return (m_marginBottom); }

    virtual void setMarginLeft(const double a_marginLeft);

    virtual double getMarginLeft() { return (m_marginLeft); }

    virtual void setMarginRight(const double a_marginRight);

    virtual double getMarginRight() { return (m_marginRight); }

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

public:

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


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

protected:

    double m_panelRadiusTopLeft;

    double m_panelRadiusTopRight;

    double m_panelRadiusBottomLeft;

    double m_panelRadiusBottomRight;

    int m_numPanelSegmentsPerCorner;

    double m_marginLeft;

    double m_marginRight;

    double m_marginTop;

    double m_marginBottom;

    bool m_showPanel;


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

protected:

    virtual void updatePanelMesh();

    void copyPanelProperties(cPanel* a_obj,
        const bool a_duplicateMaterialData,
        const bool a_duplicateTextureData, 
        const bool a_duplicateMeshData,
        const bool a_buildCollisionDetector);


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

protected:

    cColorf m_panelColorTopLeft;

    cColorf m_panelColorTopRight;

    cColorf m_panelColorBottomLeft;

    cColorf m_panelColorBottomRight;
};

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

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