gls_clipping_group.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsClippingGroup 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 INCLUDED_GLS_CLIPPING_GROUP_H
#define INCLUDED_GLS_CLIPPING_GROUP_H

#include "group.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSCLIPPINGGROUP ) || defined( GLSGEN_IMPORT_GLSCLIPPINGGROUP ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSCLIPPINGGROUP ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSCLIPPINGGROUP_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSCLIPPINGGROUP_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSCLIPPINGGROUP_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

#define LIB_BASE_NAME "gls_clipping_group"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
#ifdef GLES
class GlsGloFile;
#endif

// SetValue enumerations
enum
{
    GLS_CLIPPING_GROUP_STATE = GLS_LAST_INITIALIZER + 1,
    GLS_CLIPPING_GROUP_CLIPPING_ACTIVE,
    GLS_CLIPPING_GROUP_BOTTOM_LEFT_CORNER,
    GLS_CLIPPING_GROUP_TOP_RIGHT_CORNER,
    GLS_CLIPPING_GROUP_SHOW_OUTLINE
};

/** Runtime implementation of a GlsClippingGroup */
class GlsClippingGroup : public Group
{
public:
    friend class GlsClippingGroupEditor;
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef Group _BaseClass;
    typedef Group BaseClass;

    /** Construct a new GlsClippingGroup.
      * \param generateInstance  Whether or not to generate an instance name for this clipping group 
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT explicit GlsClippingGroup( bool generateInstance = false );

    /** Copy an existing clipping group's properties and clone its children to construct a new clipping group.
      * \param clippingGroup The clipping group whose properties to copy and whose children to clone.
      * \param generateInstance  Whether or not to generate an instance name for this clipping group 
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT GlsClippingGroup( const GlsClippingGroup& clippingGroup, bool generateInstance );

    /** Destructs a GlsClippingGroup object */
    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT ~GlsClippingGroup();

    static GLSGEN_GLSCLIPPINGGROUP_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;

#ifndef GLES
    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void Draw( void ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT DisplayObject* Pick3D( const Vector& winLoc,
        const Vector&                                                           logicalCoords,
        float                                                                   scale,
        const Vector&                                                           directionVector,
        Vector&                                                                 collisionWinLoc /*Returned*/,
        const OpenGLMatrices&                                                   drawnMatrices ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;

    //////////////////////////////////////////////////
    // GlsClippingGroup specific operations
    //////////////////////////////////////////////////

    /** \return If clipping is active for this group */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT bool ClippingActive( void ) { return _clippingActive; }

    /** Sets if clipping is active for this group
      * \param value The new clipping value
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT void ClippingActive( bool value );

    /** \return Gets bottom left corner of clip region */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT Vector Blc( void ) { return _blc; }

    /** Sets new bottom left corner for the clip region
      * \param value The new blc
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT void Blc( const Vector& value );

    /** \return Gets top right corner of clip region */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT Vector Trc( void ) { return _trc; }

    /** Sets new top right corner for the clip region
      * \param value The new trc
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT void Trc( const Vector& value );

    /** \return If clip region should always be drawn in the editor */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT bool ShowOutline( void ) { return _showOutline; }

    /** Sets if clip region should always be drawn in the editor
      * \param value The new show value
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT void ShowOutline( bool value );

protected:
    /** Get the four corners of the clip region transformed by the current DCS and offset by the group's location
      * \param tlc [out] receives top left corner
      * \param trc [out] receives top right corner
      * \param brc [out] receives bottom right corner
      * \param blc [out] receives bottom left corner
      */
    GLSGEN_GLSCLIPPINGGROUP_EXPORT void GetClipRegionCorners( Vector& tlc, Vector& trc, Vector& brc, Vector& blc );

#ifdef GLES
    /** Set a single attribute from the GLO file.
      * \param data The attribute to set and its associated data.
      */
    virtual GLSGEN_GLSCLIPPINGGROUP_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#endif

    bool   _clippingActive; /*< Whether or not to call clipping is active */
    Vector _blc;            /*< Bottom Left Corner */
    Vector _trc;            /*< Top Right Corner */
    bool   _showOutline;    /*< Outline always visible in editor */

private:
    // Deleted copy assignment; use CloneObject() or the copy constructor instead.
    void operator=( const GlsClippingGroup& ); // = delete
};

} // namespace disti

#endif