gls_rso_wrapper.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsRSOWrapper 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 _GLS_RSO_WRAPPER_H
#define _GLS_RSO_WRAPPER_H
 
#include "component_base.h"
 
#ifdef GLES
#    include "rso_interface_es_2.h"
typedef disti::RSOInterfaceES1             RsoImplBaseInterface; ///< Typedef for the original RSO interface.
typedef disti::RSOInterfaceES2::RSOPainter RSOPainterT;          ///< Typedef for the RSO interface painter type.
#else
#    include "rso_interface_5.h"
typedef disti::RSOInterface1             RsoImplBaseInterface; ///< Typedef for the original RSO interface.
typedef disti::RSOInterface5::RSOPainter RSOPainterT;          ///< Typedef for the RSO interface painter type.
#endif
 
namespace disti
{
class AttributeWrapperMap;
class EmittedEventHandlerImpl;
class MouseEvent;
 
/** The GlsRSOWrapper class wraps an RsoImplBaseInterface object
    so that it can be inserted into the GL Studio heirarchy.
  */
class GlsRSOWrapper : public ComponentBase
    , virtual public RSOPainterT
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef ComponentBase _BaseClass; ///< Deprecated typedef for the base class.
    typedef ComponentBase BaseClass;  ///< Typedef for the base class.
 
    /// Constructor
    /// \param rso The RSO to wrap.
    /// \param RSOVersion The highest RSOInterface the RSO supports (e.g. 1,2,3).
    GLS_EXPORT GlsRSOWrapper( RsoImplBaseInterface* rso, unsigned int RSOVersion );
 
    /// Call CreateInstance() and Destroy() instead of new and delete
    /// in a mixed-library environment to ensure that matching
    /// new and delete operators are called.
    /// \param rso The RSO to wrap.
    /// \param RSOVersion The highest RSOInterface the RSO supports (e.g. 1,2,3).
    /// \return A pointer to a new GlsRSOWrapper object.
    static GLS_EXPORT GlsRSOWrapper* CreateInstance( RsoImplBaseInterface* rso, unsigned int RSOVersion );
 
    /** Destructor
      * Don't call "delete yourComponent;", instead call "yourComponent->Destroy();" 
      * to ensure that the object is deleted correctly.
      */
    virtual GLS_EXPORT ~GlsRSOWrapper();
 
    /** Utility Method: Users should call Destroy() instead.
      * Safely delete an object that was created using CreateInstance.
      */
    virtual GLS_EXPORT void DeleteInstance();
 
    /** Replace the RSO that the GlsRSOWrapper is wrapping.
      * \param rso The new RSO to use
      * \param deleteCurrent Whether to delete the currently referenced rso. If false, then the caller is responsible for deleting it.
      */
    GLS_EXPORT void ChangeRSO( RsoImplBaseInterface* rso, bool deleteCurrent = true );
 
    /// \return The current RSOInterface object.
    GLS_EXPORT RsoImplBaseInterface* RSOInterface();
 
    /// \return The rso version.
    unsigned int GetRSOVersion() const
    {
        return _rsoVersion;
    }
 
    /// Handle an event that was emitted from the RSO.
    /// \param ev The event to handle.
    /// \return Non-zero if the event was handled, otherwise zero.
    GLS_EXPORT int HandleEmittedEvent( RsoImplBaseInterface::Event* ev );
 
    /// \return The qualified instance name of the initiator of the last
    /// event that was passed to HandleEmittedEvent or "" if no events
    /// have been passed to HandleEmittedEvent.
    GLS_EXPORT const char* LastEmittedEventInitiatorName() const;
 
    // DisplayObject overrides
 
    virtual GLS_EXPORT void     AlphaMode( int mode ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      AlphaMode() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     AntiAlias( bool alias ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT bool     AntiAlias() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     SetBlendColor( const GlsColor& color ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT GlsColor GetBlendColor() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT GlsColor GetColor() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     SetColor( const GlsColor& color ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     CullBackFace( const bool val ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT bool     CullBackFace() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      DepthTest() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     DepthTest( unsigned char zbuf ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT bool     LightingEnabled() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     LightingEnabled( bool lighting ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      LineStippleMultiplier() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     LineStippleMultiplier( int mult ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      LineStipplePattern() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     LineStipplePattern( int pattern ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT float    LineWidth() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     LineWidth( float width ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      MaterialIndex() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     MaterialIndex( int index ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      PolygonMode() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     PolygonMode( int mode ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      PolygonEnd() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     PolygonEnd( const int end ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      Shading() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     Shading( const int shading ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      TextureIndex() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     TextureIndex( int textureIndex ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT bool     TextureRepeat() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     TextureRepeat( const int rep ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      TextureMappingTechnique() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     TextureMappingTechnique( const int map ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      TextureMagnificationFilter() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     TextureMagnificationFilter( const int filter ) DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT int      TextureMinificationFilter() DISTI_METHOD_OVERRIDE;
    virtual GLS_EXPORT void     TextureMinificationFilter( const int filter ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void AbsolutePlacement( bool filter ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void Calculate( double time ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void CalculateBoundingBox() DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void CopyGeometry( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
 
#ifndef GLES
    virtual GLS_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif
    virtual GLS_EXPORT void CreateObjects() DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void GetExtents( float& x, float& y, float& z, float& x1, float& y1, float& z1 ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void GetTransformedExtents( Vector& min, Vector& max, const GlsMatrixType& matrix, bool resetMinMax = true ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT DisplayObject* handle( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT DisplayObject* HandleInput( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void Init() DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void Initialize() DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT DisplayObject* Pick3D( const Vector& winLoc,
        const Vector&                                       logicalCoords,
        float                                               scale,
        const Vector&                                       directionVector,
        Vector&                                             collisionWinLoc /*Returned*/,
        const OpenGLMatrices&                               drawnMatrices ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void PreDraw( const OpenGLMatrices& current, Culler& culler ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT void GetResources( std::ostream& outstr, GlsResourceFilter* filter = NULL ) DISTI_METHOD_OVERRIDE;
 
    virtual GLS_EXPORT DistiAttributeBase& Resource( const char* name ) DISTI_METHOD_OVERRIDE;
 
    /* Unhides base class implementation. */
    using ComponentBase::Rotate;
    using ComponentBase::Scale;
 
    virtual void GLS_EXPORT UpdateBoundingVolume() DISTI_METHOD_OVERRIDE;
 
    GLS_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;
 
    virtual void GLS_EXPORT Invalidate() DISTI_METHOD_OVERRIDE;
    virtual void GLS_EXPORT SetPainter( GlsPainter* painter ) DISTI_METHOD_OVERRIDE;
 
protected:
    /** enum that guides the state machine for multitouch handling for RSO's that don't support multitouch.  
      * An RSO starts in the READY_FOR_INPUT state.  When it handles a mouse drag event, it moves to PROCESSING_MOUSE_DRAG
      * state.  It will ignore any other mouse events if they are not for the original cursor_id.  Then, once the RSO either receives the 
      * MOUSE_UP event or stops handling the MOUSE_DRAG events, the RSO then transitions to WAITING_FOR_MOUSE_DOWN (i.e. it keeps ignoring other cursors
      * that might have been dragging on it while it was processing its original cursor event).  Once it receives a new mouse down, it transitions back to READY_FOR_INPUT
      */
    enum MultitouchState
    {
        READY_FOR_INPUT,
        PROCESSING_MOUSE_DRAG,
        WAITING_FOR_MOUSE_DOWN
    };
 
    RsoImplBaseInterface*    _rsoInterface;                  ///< The RSO being wrapped by this interface.
    AttributeWrapperMap*     _attributeWrapperMap;           ///< A map of attributes that wrap to the attributes within the RSO.
    EmittedEventHandlerImpl* _rsoEmittedEventHandler;        ///< The event handler for the RSO.
    char*                    _lastEmittedEventInitiatorName; ///< The name of the last object who emitted an event that made it to the event handler.
    MultitouchState          _multitouchState;               ///< The current multitouch input state, \see MultitouchState
    unsigned int             _currentCursor;                 ///< The cursor id of the current mouse / touch interacting with the RSO.
    unsigned int             _rsoVersion;                    ///< The interface version of the wrapped RSO.
 
    /// Set the name of the object who most recently emitted an event that was handled by the event handler.
    /// \note Not normally called by users.
    /// \param name The new object name to set.
    GLS_EXPORT void LastEmittedEventInitiatorName( const char* name );
 
    /// This function should be called to handle mouse events if the RSO handles multitouch (RSO version 3 or greater).
    /// \note Not normally called by users.
    /// \param mev The event to handle.
    /// \return A pointer to the object that received the event, or NULL.
    virtual GLS_EXPORT DisplayObject* HandleMultiTouchInput( MouseEvent* mev );
};
 
} // namespace disti
 
#endif