gls_rso_interface_3_impl.h

Go to the documentation of this file.

/*! \file
  \brief  Standard GL Studio implementation of the safe interface to version 2 RSOs (component side).

  \par Copyright Information

  Copyright (c) 2015 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_INTERFACE_3_IMPL_H
#define _GLS_RSO_INTERFACE_3_IMPL_H

#include "rso_interface_3.h"
#include "gls_include.h"
#include "events.h"
#include "gls_resources.h"

namespace disti {

class ComponentBase;

    /** Wraps a GlsResourceFilter so it can be passed to the RSO Interface's GetResources call */
class RSOResourceFilterImpl : public RSOInterface1::ResourceFilter
{
private:
    GlsResourceFilter *_filter;

public:
            GLS_EDITOR RSOResourceFilterImpl(GlsResourceFilter *filter) { _filter = filter; }
    virtual GLS_EDITOR ~RSOResourceFilterImpl()         { }

    // How many levels of qualification to show in the name.
    // -1 means full qualification.
    // Default: 0  // TODO: confirm this default
    virtual int LevelsUp() const                        { return _filter->LevelsUp(); }
    virtual void LevelsUp(int value)                    { _filter->LevelsUp(value); }
        
    // How many levels of children to show.
    //  0 means don't show any children properties
    // -1 means all the way down.
    // Default: -1
    virtual int GroupLevelsDown() const                 { return _filter->GroupLevelsDown(); }
    virtual void GroupLevelsDown(int value)             { _filter->GroupLevelsDown(value); }
        
    // If true, only a list of names will be returned.
    // Values will not be returned.
    // The format changes to not include the ":".
    // Default: false
    virtual bool NamesOnly() const                      { return _filter->NamesOnly(); }
    virtual void NamesOnly(bool value)                  { _filter->NamesOnly(value); }

    // Manage the list of excluded attributes
    virtual void AddExclude(const char* str)            { _filter->AddExclude(str); }
    // Returns the number of entries in the exclude list.
    // Default: 0
    virtual int ExcludeCount() const                    { return _filter->ExcludeCount(); }
    // Returns NULL if index >= ExcludeCount() or index < -1
    virtual const char* GetExclude(int index) const     { return _filter->GetExclude(index); }

    // Manage the list of included attributes
    virtual void AddInclude(const char* str)            { _filter->AddInclude(str); }
    // Returns the number of entries in the include list.
    // Default: 0
    virtual int IncludeCount() const                    { return _filter->IncludeCount(); }
    // Returns NULL if index >= IncludeCount() or index < -1
    virtual const char* GetInclude(int index) const     { return _filter->GetInclude(index); }

    // Check a name against the filters
    // Exclude list takes precedence
    virtual bool PassFilter(const char* name) const     { return _filter->PassFilter(name); }

    // Manage the stack of parent object names
    virtual void PushParentName(const char *parent)     { _filter->PushParentName(parent); }
    virtual void PopParentName()                        { _filter->PopParentName(); }
    // Returns the number of entries in the parent name stack
    virtual unsigned int ParentNameCount() const        { return _filter->ParentNameCount(); }
    // Returns NULL if index >= ParentNameCount() or index < -1
    virtual const char *GetParentName(unsigned int index) const     { return _filter->GetParentName(index); }
};

/** Implementation of the RSOInterface3. */
class GlsRSOInterface3Impl : public RSOInterface3
{
protected:
    // Copied from GlsRSOInterface1Impl {
    // Reference to the component being wrapped
    // GlsRSOInterface1Impl will delete this object
    ComponentBase* _component;

    // The containers event handler
    RSOInterface1::EmittedEventHandler* _emittedEventHandler;

    // string to return from Resources methods
    std::string _resourcesRetVal;
    // } Copied from GlsRSOInterface1Impl

    // RSOInterface2 implementation

    typedef std::map<ResourceHandle, DistiAttributeBase *> ResourceHandleMap;

    ResourceHandleMap   _resourceHandleMap;
    ResourceHandle      _nextResourceHandle;
    bool _firstDraw;

    // Protected constructor - Call CreateInstance instead
    GLS_EXPORT GlsRSOInterface3Impl(ComponentBase *component);

    // Protected destructor - Call DeleteInstance instead
    virtual GLS_EXPORT ~GlsRSOInterface3Impl();

public:
    static GLS_EXPORT GlsRSOInterface3Impl *CreateInstance(ComponentBase *component);

    // Copied from GlsRSOInterface1Impl {
    // Pass an event that was emitted from the component to the container
    GLS_EXPORT int LiveComponentEventHandlerCb(ComponentBase*, disti::DisplayEvent* ev);

    // RSOInterface1 overrides

    virtual GLS_EXPORT void Calculate(double time);

    virtual GLS_EXPORT RSOInterface1* CloneObject();

    virtual GLS_EXPORT void DeleteInstance();

    virtual GLS_EXPORT void Draw();

    virtual GLS_EXPORT bool SetEmittedEventHandler(RSOInterface1::EmittedEventHandler* handler);

    virtual GLS_EXPORT bool GetBoundingSphere(RSOInterface1::Vector* center, float* radius);

    virtual GLS_EXPORT bool GetBoundingBox(RSOInterface1::Vector* min, RSOInterface1::Vector* max, const RSOInterface1::MatrixD* transform = NULL);

    virtual GLS_EXPORT bool HandleInput(RSOInterface1::Event* lci1_ev);

    virtual GLS_EXPORT bool HandleMultiTouchInput(RSOInterface3::MouseMultiTouchEvent *lci3_ev);

    virtual GLS_EXPORT bool Pick3D(const RSOInterface1::Vector& winLoc,
                        const RSOInterface1::Vector& logicalCoords,
                        float scale, 
                        const RSOInterface1::Vector& directionVector, 
                        RSOInterface1::Vector& collisionWinLoc, 
                        const RSOInterface1::OpenGLMatrices& drawnMatrices);

    virtual GLS_EXPORT void PreDraw(const RSOInterface1::OpenGLMatrices& parentMatrices, RSOInterface1::Culler& culler);

    virtual GLS_EXPORT void SetResource(const char* resourceName, const char* resourceVal);

    virtual GLS_EXPORT const char* GetResource(const char* resourceName);

    virtual GLS_EXPORT const char* GetResources(RSOInterface1::ResourceFilter* filter = NULL);
    // } Copied from GlsRSOInterface1Impl

    // RSOInterface2 implementation

    virtual ResourceHandle CreateResourceHandle(const char *resourceName);

    virtual void ReleaseResourceHandle(ResourceHandle resourceHandle);

    virtual bool IsResourceHandleValid(ResourceHandle resourceHandle);

    virtual void SetResource(ResourceHandle resourceHandle, const char *resourceVal);

    virtual const char *GetResource(ResourceHandle resourceHandle);

    virtual void SetIntResource(const char *resourceName, long resourceVal);

    virtual long GetIntResource(const char *resourceName);

    virtual void SetIntResource(ResourceHandle resourceHandle, long resourceVal);

    virtual long GetIntResource(ResourceHandle resourceHandle);

    virtual void SetFloatResource(const char *resourceName, double resourceVal);

    virtual double GetFloatResource(const char *resourceName);

    virtual void SetFloatResource(ResourceHandle resourceHandle, double resourceVal);

    virtual double GetFloatResource(ResourceHandle resourceHandle);
};

} // end namespace disti

#endif