glpolygon_glyph.h

Go to the documentation of this file.

/*! \file
  \brief  Implementation of the disti::GLPolygonGlyph Primitive Class for text objects.

  \par Copyright Information

  Copyright (c) 2015 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 _GLPOLYGON_GLYPH_H
#define _GLPOLYGON_GLYPH_H

#include "display.h"
#include "gls_include.h"

namespace disti
{

/**  The Polygon Glyph class.  Implements Polygon Glyphs
  *  Used in the Font Class to draw Glyphs.  One or more
  *  of this instances class makes up a single Glyph.
  */
class GLPolygonGlyph : public DisplayObject
{
    private:

    protected:

    /* The polygon drawing mode for this object. This is expected to be an OpenGl drawing 
      * mode (e.g.: GL_POLYGON) since it is used directly in glBegin */
    int _gl_drawing_mode; 
    
    public:

    /** Constructor, Creates a Glyph with the vertices specified
      * \param nPoints   The number of vertices in the new polygon
      * \param vertices  The array of vertices for the polygon, in
      *                  world coordinate system
      */
    GLS_EXPORT GLPolygonGlyph(int nPoints,Vertex *vertices);
    
    //
    // No destructor for this child class of DisplayObject.
    // ~DisplayObject does all that is required!
    //
    
    /** Draw this Glyph polygon.  It is assumed that the calling
      * functions have set up all of the draw parameters, location,
      * rotation, color, line size, ... */
    virtual GLS_EXPORT void Draw(void);

    /* Sets the polygon drawing mode for this object
      * \param mode The new polygon drawing mode for this object
      *             This is expected to be an OpenGl drawing mode
      *             it is used directly in glBegin
      */
    virtual GLS_EXPORT void GLDrawingMode(int mode);

    /* Copy+Create operation in one method. In derived classes, this
      * method will create a new instance of the derived class and then
      * copy the object into the new instance. The cut,copy,paste and undo
      * operations use this method.
      * \param generateNames  Whether or not to generate new names for cloned objects
      * \return A new object, identical to the original, except for the instance name
      */
    virtual GLS_EXPORT DisplayObject *CloneObject(bool generateNames = false);

};

} // namespace disti

#endif