DDD_GlsDisplayFrameAdapter.h

Go to the documentation of this file.

/*! \file DDD_GlsDisplayFrameAdapter.h
  \brief Adapts a GlsDisplayFrame to be an RSO_Asset container.  
  
  \par Copyright Information

  Copyright (c) 2012 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 POSSIBLITY
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 DDD_GlsDisplayFrameAdapter_H_
#define DDD_GlsDisplayFrameAdapter_H_

#include <string>
#include "DDD_AssetBase.h"
#include "DDD_AttributeList.h"
#include "DDD_DataDirector.h"

namespace disti
{

class glsDisplayFrame;

class DDD_EXPORT DDD_GlsDisplayFrameAdapter 
{
protected:
    DDD_DataDirector *_director;   /**< Data Director instance */
    glsDisplayFrame  *_frame;      /**< glsDisplayFrame associated with this adapter */

public:
    /** Constructor.
      * \param frame  The glsDisplayFrame to associate with this adapter */
    DDD_GlsDisplayFrameAdapter(glsDisplayFrame *frame);

    /** Destructor */
    virtual ~DDD_GlsDisplayFrameAdapter();

    /** Load a Data Director XML config file.  Any RSO assets in the config file
      * will be treated as references to RSOs contained in the associated glDisplayFrame
      * \param filename  The name of the XML file to load
      * \return True if the XML was successfully parsed
      */
    bool LoadXML(const char *filename);

    /** Pump the Data Director instance associated with this adapter.  This call is normally placed into
      * the Calculate method of the glsDisplayFrame associated with this adapter
      * \param time The process/calculate time 
      */
    void Process(double time);

    /** \return Returns a pointer to the glsDisplayFrame associated with this adapter */
    glsDisplayFrame  *GetDisplayFrame() { return _frame; }

    /** Searches all instantiated assets for the attribute
      * \param name  The fully qualified name of the attribute to find (e.g. assetName.attribName)
      * \return Returns a pointer to the attribute or NULL if not found
      */
    DDD_AttributeBase *FindAttribute(const std::string &name) { return _director->FindAttribute(name); }

    /** Searches all instantiated assets by name
      * \param assetName  Asset instance name to find
      * \return Returns a pointer to the asset if found or NULL if not found
      */
    DDD_AssetBase *FindAsset(const std::string &name) { return _director->FindAsset(name); }

    /** Starts all assets */
    void StartAssets() { _director->StartAllAssets(); _director->ResumeAllAssets(); }

    /** Stops all assets */
    void StopAssets() { _director->StopAllAssets(); }

};

} //end of namespace disti
#endif