gls_group.h

Go to the documentation of this file.

#ifndef _GLS_GROUP_H
#define _GLS_GROUP_H

/*! \file gls_group.h

\brief  This header defines the GlsGroup 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_composite_object.h"
#include "gls_display_object_array.h"
#include "gls_class_invariant.h"

/** This class implements a group of display objects.
  * \invariant base class invariant, _objects.Invariant()
  */
class GlsGroup : public GlsCompositeObject
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsGroup )

    /** initialization parameters for a GlsGroup */
    struct InitParameters
    {
        const GlsCompositeObject::InitParameters compositeInitParameters; /**< base class init parameters */

        GlsDisplayObjectArray::InitParameters objectArrayInitParameters; /**< init parameters for object array */

        /** create a copy of the init parameters with the object array init
          *    objects array replaced with the given array of objects
          * \param newObjects new array of ojects
          * \return copy of given init parameters with object array init objects array replaced
          * \pre newObjects != GLS_NULL,
          *      newObjects array has initParameters.objectArrayInitParameters.numObjects elements
          * \post none
          */
        InitParameters CopyWithObjectsArray( GlsDisplayObject* const *newObjects ) const;

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

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

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

    /** Provides a mechanism for performing regular calculations, separate 
      * from drawing. 
      * \param time The elaspsed time in seconds since program start
      * \pre time >= 0.0
      * \post calculations (if any) completed for all contained objects
      */
    virtual void Calculate( const GlsFloat64 time );

    /** Perform a pick test of the given point in window coordinates against this object
      * \param windowCoord point in question
      * \param inputManager input manager managing input for this object
      * \param parentDrawMatrix draw matrix used when rendering parent object
      * \return object that is picked by given window coordinate else GLS_NULL
      * \pre windowCoord.IsValid(), GLMatrixAffineFIsValid( parentDrawMatrix )
      * \post none
      */
    virtual GlsDisplayObject* PickTest( const GlsVector2D &windowCoord, GlsInputManager &inputManager,
                                        const GlsMatrixAffineD::GLMatrixAffineF &parentDrawMatrix );

    /** Set the alpha mode of the contained objects
      * \param alphaMode desired alpha mode
      * \pre GlsAlphaModeIsValid( alphaMode )
      * \post contained objects have new alpha mode
      */
    virtual void SetChildrenAlphaMode( const GlsAlphaMode alphaMode );

    /** Set the fill color of the contained objects
      * \param fillColor desired fill color
      * \pre fillColor.IsValid()
      * \post contained objects have new fill color
      */
    virtual void SetChildrenFillColor( const GlsColor &fillColor );

    /** Set the line color of the contained objects
      * \param lineColor desired line color
      * \pre lineColor.IsValid()
      * \post contained objects have new line color
      */
    virtual void SetChildrenLineColor( const GlsColor &lineColor );

    /** Set the line width of the contained objects
      * \param lineWidth new line width, GlsRenderObject::LINE_WIDTH_MIN <= lineWidth <= GlsRenderObject::LINE_WIDTH_MAX
      * \pre GlsLineWidthIsValid( lineWidth )
      * \post contained objects have new line width
      */
    virtual void SetChildrenLineWidth( const GlsFloat32 lineWidth );

    /** Set the polygon mode of the contained objects
      * \param polygonMode new polygon mode
      * \pre GlsPolygonModeIsValid( polygonMode )
      * \post contained objects have new polygon mode
      */
    virtual void SetChildrenPolygonMode( const GlsPolygonMode polygonMode );

protected:
    GlsDisplayObjectArray _objects; /**< array of display objects */

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

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

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

#endif // _GLS_GROUP_H