boxes/boxtransport/orboxtransport_box.cxx

/***************************************************************************************
 Autodesk(R) Open Reality(R) Samples
 
 (C) 2009 Autodesk, Inc. and/or its licensors
 All rights reserved.
 
 AUTODESK SOFTWARE LICENSE AGREEMENT
 Autodesk, Inc. licenses this Software to you only upon the condition that 
 you accept all of the terms contained in the Software License Agreement ("Agreement") 
 that is embedded in or that is delivered with this Software. By selecting 
 the "I ACCEPT" button at the end of the Agreement or by copying, installing, 
 uploading, accessing or using all or any portion of the Software you agree 
 to enter into the Agreement. A contract is then formed between Autodesk and 
 either you personally, if you acquire the Software for yourself, or the company 
 or other legal entity for which you are acquiring the software.
 
 AUTODESK, INC., MAKES NO WARRANTY, EITHER EXPRESS OR IMPLIED, INCLUDING BUT 
 NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE REGARDING THESE MATERIALS, AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN 
 "AS-IS" BASIS.
 
 IN NO EVENT SHALL AUTODESK, INC., BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, 
 INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE 
 OR USE OF THESE MATERIALS. THE SOLE AND EXCLUSIVE LIABILITY TO AUTODESK, INC., 
 REGARDLESS OF THE FORM OF ACTION, SHALL NOT EXCEED THE PURCHASE PRICE OF THE 
 MATERIALS DESCRIBED HEREIN.
 
 Autodesk, Inc., reserves the right to revise and improve its products as it sees fit.
 
 Autodesk and Open Reality are registered trademarks or trademarks of Autodesk, Inc., 
 in the U.S.A. and/or other countries. All other brand names, product names, or 
 trademarks belong to their respective holders. 
 
 GOVERNMENT USE
 Use, duplication, or disclosure by the U.S. Government is subject to restrictions as 
 set forth in FAR 12.212 (Commercial Computer Software-Restricted Rights) and 
 DFAR 227.7202 (Rights in Technical Data and Computer Software), as applicable. 
 Manufacturer is Autodesk, Inc., 10 Duke Street, Montreal, Quebec, Canada, H3C 2L7.
***************************************************************************************/

//--- Class declaration
#include "orboxtransport_box.h"

//--- Registration defines
#define ORBOXTRANSPORT__CLASS       ORBOXTRANSPORT__CLASSNAME
#define ORBOXTRANSPORT__NAME        ORBOXTRANSPORT__CLASSSTR
#define ORBOXTRANSPORT__LOCATION    "Plugins"
#define ORBOXTRANSPORT__LABEL       "OR - Transport Box"
#define ORBOXTRANSPORT__DESC        "OR - Transport Control Box"

//--- TRANSPORT implementation and registration
FBBoxImplementation (   ORBOXTRANSPORT__CLASS   );  // Box class name
FBRegisterBox       (   ORBOXTRANSPORT__NAME,       // Unique name to register box.
                        ORBOXTRANSPORT__CLASS,      // Box class name
                        ORBOXTRANSPORT__LOCATION,   // Box location ('plugins')
                        ORBOXTRANSPORT__LABEL,      // Box label (name of box to display)
                        ORBOXTRANSPORT__DESC,       // Box long description.
                        FB_DEFAULT_SDK_ICON     );  // Icon filename (default=Open Reality icon)
/************************************************
 *  TRANSPORT Creation
 ************************************************/
bool ORBoxTransport::FBCreate()
{
    /*
    *   Create the nodes for the box.
    */
    mPlay = AnimationNodeInCreate   ( 0, "Play",        ANIMATIONNODE_TYPE_NUMBER );
    mPull = AnimationNodeOutCreate  ( 1, "Must Pull",   ANIMATIONNODE_TYPE_NUMBER );

    return true;
}


/************************************************
 *  TRANSPORT Destruction.
 ************************************************/
void ORBoxTransport::FBDestroy()
{
    /*
    *   Free any user memory associated to box.
    */
}


/************************************************
 *  Real-time engine evaluation
 ************************************************/
bool ORBoxTransport::AnimationNodeNotify( FBAnimationNode* pAnimationNode, FBEvaluateInfo* pEvaluateInfo )
{
    /*
    *   1. Read the data from the in connector
    *   2. Treat the data as required
    *   3. Write the data to the out connector
    *   4. Return the status (LIVE/DEAD) of the box.
    */
    double lValue;
    bool lStatus;

    lStatus = mPlay->ReadData( &lValue, pEvaluateInfo );
    if( lStatus )
    {
        mPull->WriteData( &lValue, pEvaluateInfo );
        if( lValue != 0.0 )
        {
            if( mPlayerControl.GetTransportMode() != kFBTransportPlay )
            {
                mPlayerControl.Play();
            }
        }
        return true;
    }
    return false;
}


/************************************************
 *  FBX Storage.
 ************************************************/
bool ORBoxTransport::FbxStore( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat )
{
    /*
    *   Store box parameters.
    */
    return true;
}


/************************************************
 *  FBX Retrieval.
 ************************************************/
bool ORBoxTransport::FbxRetrieve(FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat )
{
    /*
    *   Retrieve box parameters.
    */
    return true;
}