gls_composite_object.h

Go to the documentation of this file.

#ifndef _GLS_COMPOSITE_OBJECT_H
#define _GLS_COMPOSITE_OBJECT_H

/*! \file gls_composite_object.h
\brief  This header defines the GlsCompositeObject class used 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_settings.h"
#include "gls_display_object.h"
#include "gls_class_invariant.h"

/** The GlsCompositeObject is an abstract base class that serves as an interface for manipulating
  * sets of display objects.
  * \invariant base class invariant holds
  */
class GlsCompositeObject : public GlsDisplayObject
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsCompositeObject )

    /** Initialization parameters for a GlsCompositeObject */
    struct InitParameters
    {
        const GlsDisplayObject::InitParameters displayInitParameters; /**< init parameters for base class */

        #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
    };

    /** 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 ) = 0;

    /** 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 ) = 0;

    /** 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 )= 0;

    /** 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 )= 0;

    /** 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 )= 0;

protected:
    /** Constructor - create instance
      * \param initParameters initialization parameters for instance
      * \param eventDispatcher event dispatcher for this object else GLS_NULL
      * \pre initParameters.IsValid()
      * \post instance is constructed
      */
    GlsCompositeObject( const InitParameters &initParameters, GlsEventDispatcher* const eventDispatcher );

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

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

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

#endif // _GLS_COMPOSITE_OBJECT_H