gls_polygon.h

Go to the documentation of this file.

#ifndef _GLS_POLYGON_H
#define _GLS_POLYGON_H

/*! \file gls_polygon.h
\brief  This header defines the GlsPolygon class in
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_render_object.h"
#include "gls_vertex.h"
#include "gls_texture_vertex_array.h"
#include "gls_state_manager.h"
#include "gls_class_invariant.h"

/** The GlsPolygon abstracts an ordered set of two or more textured
  * vertices.
  * \invariant base class invariant holds,
  *            _vertices.Invariant()
  */
class GlsPolygon : public GlsRenderObject
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsPolygon )

    /** initialization parameters for the GlsPolygon */
    struct InitParameters
    {
        const GlsRenderObject::InitParameters renderInitParameters; /**< base class initialization */

        const GlsTextureVertexArray::InitParameters verticesInitParameters; /**< initial vertices */

        #if defined( GLS_DEBUG )
            /** Determine if the initialization parameters are valid ( GLS_DEBUG only )
              * \return GLS_TRUE if valid else GLS_FALSE
              * \pre none
              * \post none
              */
            GlsBool IsValid( void ) const;
        #endif // GLS_DEBUG
    };

    /** Constructor - create instance
      * \param initParameters initialization parametets
      * \param eventDispatcher event dispatcher for this object else GLS_NULL
      * \pre initParameters.IsValid()
      * \post instance created
      */
    GlsPolygon( const InitParameters &initParameters, GlsEventDispatcher* const eventDispatcher );

    /** Draws this polygon
      * \param gl GL State manager for OpenGL into which polygon is drawn
      * \param time the elaspsed time in seconds since program start
      * \pre time >= 0.0
      * \post polygon is drawn to OpenGL if visible and not blinked off
      */
    virtual void Draw( GlsStateManager &gl, const GlsFloat64 time );

    /** Offset the texture on the object
      * \param offset x, y offset for texture
      * \pre offset.IsValid()
      * \post offset is added to the texture coordinates
      */
    virtual void OffsetTexture( const GlsVector2D &offset );

    /** Set one of the vertices in the polygon
     * \param index index of desired vertex
     * \param vertex new value of desired vertex
     * \pre index is less than the number of vertices in the polygon,
     *      vertex.IsValid()
     * \post vertex at desired index has new value
     */
    void SetVertex( const GlsUInt32 index, const GlsTextureVertex &vertex );

protected:
    GlsTextureVertexArray   _vertices;  /**< array of vertices for polygon */

    /** Destructor - shall never be called
      * \pre none
      * \post none 
      */
    virtual ~GlsPolygon();

private:
    typedef GlsRenderObject _BaseClass; /**< base class alias */

    // Disable implicit generated Members
    GlsPolygon& operator=( const GlsPolygon &rhs );
    GlsPolygon( const GlsPolygon &src );
};

#endif // _GLS_POLYGON_H