gls_ellipse.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsEllipse class.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef _GLSELLIPSE_H
#define _GLSELLIPSE_H
#include "glpolygon.h"
#include "gls_cpp_lang_support.h"
 
#ifdef GLES
#    include "gls_index_array.h"
#    include "gls_vertex_array.h"
#else
#    include "gls_display_list.h"
#endif
/// Provides support for creating DLLs.
#if( defined( GLSGEN_EXPORT_GLSELLIPSE ) || defined( GLSGEN_IMPORT_GLSELLIPSE ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSELLIPSE ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSELLIPSE_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSELLIPSE_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSELLIPSE_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
/// Automatically link the runtime library plugin (on Windows).
#define LIB_BASE_NAME "gls_ellipse"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME
 
namespace disti
{
// SetValue enumerations
enum
{
    GLS_ELLIPSE_FIRST_VALUE = GLS_LAST_INITIALIZER + 1,
    GLS_ELLIPSE_RADII,
    GLS_ELLIPSE_THICKNESS,
    GLS_ELLIPSE_SOLID,
    GLS_ELLIPSE_INTERVAL,
    GLS_ELLIPSE_START_ANGLE,
    GLS_ELLIPSE_END_ANGLE,
    GLS_ELLIPSE_COLOR
};
 
/** Runtime implementation of a GlsEllipse */
class GlsEllipse : public GLPolygon
{
    friend class GlsEllipseEditor;
 
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef GLPolygon _BaseClass; ///< Deprecated typedef for the base class.
    typedef GLPolygon BaseClass;  ///< Typedef for the base class.
 
    /** Create a new GlsEllipse.
      * \param generateInstance  Whether or not to generate an instance name
      * for this inputdevice */
    GLSGEN_GLSELLIPSE_EXPORT GlsEllipse( bool generateInstance = false );
 
    /// Copy Constructor
    /// \param that The object to copy from.
    /// \param generateNames Whether or not to generate an instance name.
    GLSGEN_GLSELLIPSE_EXPORT GlsEllipse( const GlsEllipse& that, const bool generateNames );
 
    /** Destructs a GlsEllipse object */
    virtual GLSGEN_GLSELLIPSE_EXPORT ~GlsEllipse();
 
    /// \return A pointer to a new GlsEllipse object.
    static GLSGEN_GLSELLIPSE_EXPORT DisplayObject* CreateInstance();
 
    virtual GLSGEN_GLSELLIPSE_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void           CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void           CopyGeometry( DisplayObject* srcArg ) DISTI_METHOD_OVERRIDE;
 
#ifndef GLES
    virtual GLSGEN_GLSELLIPSE_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif
 
    virtual GLSGEN_GLSELLIPSE_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void Scale( float px, float py, float pz, Vertex* anchor, int handleBar ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void Rotate( const Vector& orig, float angle, const Vector& axis ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT bool Hit( float x, float y, float z, float scale, const Vector& directionVector, Vector* collisionPoint ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void CalculateTextureCoordinates() DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT Vertex* Vertices() DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void    GetExtents( float& minx, float& miny, float& minz, float& maxx, float& maxy, float& maxz ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void    GetTransformedExtents( Vector& min, Vector& max, const GlsMatrixType& matrix, bool resetMinMax ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSELLIPSE_EXPORT void    UpdateBoundingVolume() DISTI_METHOD_OVERRIDE;
 
    /* Unhides base class implementation. */
    using BaseClass::SetFillColor;
 
    /* Unhides base class implementation. */
    using BaseClass::GetFillColor;
 
    /** Sets the color for filling the object
      * \param color  The new color for the object
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void SetFillColor( const GlsColor& color ) DISTI_METHOD_OVERRIDE;
 
    /** Gets the color for filling the object
      * \return  The fill color for the object
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT GlsColor GetFillColor() DISTI_METHOD_OVERRIDE;
 
    GLSGEN_GLSELLIPSE_EXPORT DisplayObject* handle( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSELLIPSE_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;
 
    /// Configure the OpenGL texture state for this object.
    /// \note Not normally called by users.
    /// \return True if the OpenGL state was changed.
    virtual GLSGEN_GLSELLIPSE_EXPORT bool SetupTexture();
 
    //////////////////////////////////////////////////
    // GlsEllipse specific operations
    //////////////////////////////////////////////////
 
    /** Sets the radius vectors
      * \param r1
      * \param r2
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void RadiusVectors( const Vector& r1, const Vector& r2 );
 
    /// \param index The index of the radius vector to return (0 or 1).
    /// \return The radius vector for the specified index.
    virtual GLSGEN_GLSELLIPSE_EXPORT Vector RadiusVector( unsigned int index );
 
    /// \param index The index of the unit vector to return (0 or 1).
    /// \return The unit vector for the specified index.
    virtual GLSGEN_GLSELLIPSE_EXPORT Vector UnitVector( unsigned int index );
 
    /** Sets the angular interval between vertices
      * \param value the interval in degrees.
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void Interval( const unsigned int& value );
    /** Gets the angular interval between vertices.
      * \return the interval.
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT unsigned int Interval();
 
    /** Sets the thickness of the ellipse in logical units.
      * \param value The thickness in logical units.
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void Thickness( const float& value );
    /** Gets the thickness of the ellipse.
      * \return The current thickness of the ellipse in logical units.
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT float Thickness();
 
    /** Sets the Start Angle in degrees 
      * \param value The start angle
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void StartAngle( const float& value );
    /** Gets the Start Angle in degrees
      * \return The start angle in degrees
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT float StartAngle();
 
    /** Sets the end angle in degrees
      * \param value The end angle in degrees
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void EndAngle( const float& value );
    /** Gets the end angle in degrees
      * \return The end angle in degrees
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT float EndAngle();
 
    /// Sets the magnitude (thickness of the ellipse outer edge).
    /// \param value The new magnitude value to set.
    /// \param index The axis to set the magnitude on (0 or 1).
    virtual GLSGEN_GLSELLIPSE_EXPORT void Magnitude( const float& value, unsigned int index );
 
    /// \param index The axis to get the magnitude for (0 or 1).
    /// \return The magnitude (thickness of the ellipse outer edge) on the given axis.
    virtual GLSGEN_GLSELLIPSE_EXPORT float Magnitude( unsigned int index );
 
    /** Sets the solid flag
      * \param value When true the elipse is drawn solid
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT void Solid( const bool& value );
    /** Gets the solid flag
      * \return The current solid flag value
      */
    virtual GLSGEN_GLSELLIPSE_EXPORT bool Solid();
 
#ifdef GLES
    /** Causes the display list for this object to be recomputed */
    GLSGEN_GLSELLIPSE_EXPORT void InvalidateGeometry()
    {
        _geometryRefresh = true;
        InvalidatePainter();
    }
#else
    /** Causes the display list for this object to be recomputed */
    GLSGEN_GLSELLIPSE_EXPORT void InvalidateGeometry()
    {
        _displayList.Invalidate();
        InvalidatePainter();
    }
 
    /// \return A reference to this object's display list.
    GLSGEN_GLSELLIPSE_EXPORT GlsDisplayList& DisplayList() { return _displayList; }
#endif
protected:
    /** Calculates _radiiUnit and _magnitude based on _radii */
    void GLSGEN_GLSELLIPSE_EXPORT CalculateRadiiUnit();
 
    /** callback called when the ellipse needs to be recalculated because an attribute has changed 
      */
    void GLSGEN_GLSELLIPSE_EXPORT SetNeedsRecalculate();
 
#ifdef GLES
    /** Draws the arc segment mode 
      * \param textureObject TRUE if object should be drawn textured
      */
    void GLSGEN_GLSELLIPSE_EXPORT ComputeArcSegment( bool textureObject );
 
    /** Draws the solid circle mode
      * \param textureObject TRUE if object should be drawn textured
      */
    void GLSGEN_GLSELLIPSE_EXPORT ComputeSolidCircle( bool textureObject );
 
    /** Set a single attribute from the GLO file.
     * \param data The attribute to set and its associated data.
     */
    virtual GLS_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#else
    /** Draws the arc segment mode 
      * \param textureObject TRUE if object should be drawn textured
      */
    void GLSGEN_GLSELLIPSE_EXPORT DrawArcSegment( bool textureObject );
 
    /** Draws the solid circle mode
      * \param textureObject TRUE if object should be drawn textured
      */
    void GLSGEN_GLSELLIPSE_EXPORT DrawSolidCircle( bool textureObject );
 
    /** Performs OpenGL drawing commands */
    void GLSGEN_GLSELLIPSE_EXPORT DrawGeometry();
#endif
    /** Recomputes the object's vertices from its radii */
    void GLSGEN_GLSELLIPSE_EXPORT RecomputeVertices();
 
    /** Calculates the start vertices */
    void GLSGEN_GLSELLIPSE_EXPORT CalculateStartVertices();
 
    /** Calculates the end vertices */
    void GLSGEN_GLSELLIPSE_EXPORT CalculateEndVertices();
 
    /// Gets starting and ending indices for vertices.
    /// \param startAngle The start angle to calculate from in degrees.
    /// \param startIndex The returned segment index closest to the start angle.
    /// \param endAngle The end angle to calculate from in degrees.
    /// \param endIndex The returned segment index closest to the end angle.
    void GLSGEN_GLSELLIPSE_EXPORT GetSegmentIndices( const float startAngle, unsigned int& startIndex, const float endAngle, unsigned int& endIndex );
 
    /// Get the inner index, the index of the vertex on the inner edge of a non-solid ellipse.
    /// Used for picking.
    /// \param index The segment index to derive the vertex index from.
    /// \return The vertex index associated with the segment.
    unsigned int GLSGEN_GLSELLIPSE_EXPORT InnerIndex( const unsigned int index );
 
    /// Get the outer index, the index of the vertex on the outer edge of the ellipse.
    /// Used for picking.
    /// \param index The segment index to derive the vertex index from.
    /// \return The vertex index associated with the segment.
    unsigned int GLSGEN_GLSELLIPSE_EXPORT OuterIndex( const unsigned int index );
 
#ifndef GLES
    /** Stores the scale in a display list for faster drawing */
    GlsDisplayList _displayList;
#else
    GlsVertexArray                _outlineVertexArray;
#endif
    /** Stores the scale in a display list for faster drawing */
    Vector _radii[ 2 ], /**  Two radii defining the ellipse size and orientation 
                                    *  Only used to read/write file.  _radiiNormal is in control
                                    */
 
        _normal,         /**< Normal to surface defined by radii */
        _radiiUnit[ 2 ], /**< Unit vector of radii */
        _start[ 2 ],     /**< Two points defining the starting edge of a partial ellipse. */
        _startTex[ 2 ],  /**< Texture coordinates of starting points */
        _end[ 2 ],       /**< Two points defining the ending edge of a partial ellipse. */
        _endTex[ 2 ],    /**< Texture coordinates of starting points */
        _centerTex;      /**< Texture coordinate of center point */
 
    GlsColor _objectColor; /**< Fill color of object */
 
    float _thickness,    /**< Thickness of the outer edge of the ellipse in logical units */
        _startAngle,     /**< Starting angle of ellipse segment in degrees */
        _endAngle,       /**< Ending angle of ellipse segment in degrees */
        _magnitude[ 2 ]; /**< Magnitude of radii */
 
    unsigned int _interval;         /**< Interval between subdivisions, in degrees */
    bool         _solid;            /**< If true, ellipse drawn as solid not as "donut" */
    bool         _needsRecalculate; ///< If true, the ellipse vertices will be recalculated next frame from angle and radius data.
 
    GlsMatrixType _world2tex; /**< Matrix used to calculate texture coordinates for the object */
 
private:
    // disallow implicit assignments and copy constructor
    GlsEllipse& operator=( const GlsEllipse& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsEllipse( const GlsEllipse& ) DISTI_SPECIAL_MEM_FUN_DELETE;
};
 
} // namespace disti
 
#endif