devices/deviceoutput/ordeviceoutput_device.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 "ordeviceoutput_device.h"

//--- Device strings
#define ORDEVICEOUTPUT__CLASS   ORDEVICEOUTPUT__CLASSNAME
#define ORDEVICEOUTPUT__NAME    ORDEVICEOUTPUT__CLASSSTR
#define ORDEVICEOUTPUT__LABEL   "OR - Output Device"
#define ORDEVICEOUTPUT__DESC    "OR - Output Device: Light Controller"
#define ORDEVICEOUTPUT__PREFIX  "LightController"

//--- FiLMBOX implementation and registration
FBDeviceImplementation  (   ORDEVICEOUTPUT__CLASS   );
FBRegisterDevice        (   ORDEVICEOUTPUT__NAME,
                            ORDEVICEOUTPUT__CLASS,
                            ORDEVICEOUTPUT__LABEL,
                            ORDEVICEOUTPUT__DESC,
                            FB_DEFAULT_SDK_ICON     );  // Icon filename (default=Open Reality icon)

/************************************************
 *  FiLMBOX Constructor.
 ************************************************/
bool ORDeviceOutput::FBCreate()
{
    mLightTFBNode   = AnimationNodeInCreate(    0,  "Translation OUT",  ANIMATIONNODE_TYPE_LOCAL_TRANSLATION);
    mLightRFBNode   = AnimationNodeInCreate(    1,  "Rotation OUT",     ANIMATIONNODE_TYPE_LOCAL_ROTATION   );
    mLightTNode     = AnimationNodeOutCreate(   2,  "Translation",      ANIMATIONNODE_TYPE_LOCAL_TRANSLATION);
    mLightRNode     = AnimationNodeOutCreate(   3,  "Rotation",         ANIMATIONNODE_TYPE_LOCAL_ROTATION   );

    mRootTemplate   = new FBModelTemplate(      ORDEVICEOUTPUT__PREFIX, "Reference",    kFBModelTemplateRoot    );
    mLightTemplate  = new FBModelTemplate(      ORDEVICEOUTPUT__PREFIX, "Light",        kFBModelTemplateLight   );

    ModelTemplate.Children.Add(mRootTemplate);
    mRootTemplate->Children.Add(mLightTemplate);

    mLightTemplate->Bindings.Add( mLightTFBNode );
    mLightTemplate->Bindings.Add( mLightRFBNode );

    mExportRate     = 10.0;

    return true;
}


/************************************************
 *  FiLMBOX Destructor.
 ************************************************/
void ORDeviceOutput::FBDestroy()
{
}


/************************************************
 *  Device operation.
 ************************************************/
bool ORDeviceOutput::DeviceOperation( kDeviceOperations pOperation )
{
    switch (pOperation)
    {
        case kOpInit:   return Init();
        case kOpStart:  return Start();
        case kOpStop:   return Stop();
        case kOpReset:  return Reset();
        case kOpDone:   return Done();
    }
    return FBDevice::DeviceOperation( pOperation );
}


/************************************************
 *  Initialization of device.
 ************************************************/
bool ORDeviceOutput::Init()
{
    return true;
}


/************************************************
 *  Device is put online.
 ************************************************/
bool ORDeviceOutput::Start()
{
    FBProgress  lProgress;
    lProgress.Caption   = "Setting up device";

    // Step 1: Open device
    lProgress.Text  = "Opening communication to device";
    Information     = "Opening device";
    if(!mHardware.Open())
    {
        Information = "Could not open device";
        return false;
    }

    // Step 2: Ask hardware to get channel information
    lProgress.Text  = "Device found, scanning for channel information...";
    Information     = "Retrieving channel information";
    if(!mHardware.GetSetupInfo())
    {
        Information = "Could not get channel information from device.";
        return false;
    }

    // Step 3: Set the sampling rate
    lProgress.Text  = "Setting sampling rate";
    Information = "Setting sampling rate";

    FBTime  lTime;
    lTime.SetSecondDouble( 1.0 / mExportRate );
    SamplingPeriod  = lTime;

    return true;
}


/************************************************
 *  Device is stopped (offline).
 ************************************************/
bool ORDeviceOutput::Stop()
{
    FBProgress  lProgress;
    lProgress.Caption   = "Shutting down device";

    // Shutdown device
    lProgress.Text  = "Closing communication to device";
    Information     = "Closing device";
    if(! mHardware.Close() )
    {
        Information = "Could not close device";
    }

    return false;
}


/************************************************
 *  Removal of device.
 ************************************************/
bool ORDeviceOutput::Done()
{
    return false;
}


/************************************************
 *  Reset of device.
 ************************************************/
bool ORDeviceOutput::Reset()
{
    Stop();
    return Start();
}


/************************************************
 *  Real-Time Engine Evaluation.
 ************************************************/
bool ORDeviceOutput::AnimationNodeNotify(FBAnimationNode* pAnimationNode ,FBEvaluateInfo* pEvaluateInfo)
{
    double  lPos[3];
    double  lRot[3];

    mLightTFBNode->ReadData( lPos, pEvaluateInfo );
    mLightRFBNode->ReadData( lRot, pEvaluateInfo );

    mLightTNode->WriteData( lPos, pEvaluateInfo );
    mLightRNode->WriteData( lRot, pEvaluateInfo );

    return true;
}


/************************************************
 *  Device Evaluation Notify.
 ************************************************/
bool ORDeviceOutput::DeviceEvaluationNotify(kTransportMode pMode, FBEvaluateInfo* pEvaluateInfo)
{
    switch(pMode)
    {
        case kPreparePlay:
        case kPlayReady:
        case kPlayStop:
        case kJog:
        {
        }
        break;
        case kStop:
        case kPlay:
        {
            double lPos[3];
            double lRot[3];

            mLightTNode->ReadData( lPos, pEvaluateInfo );
            mLightRNode->ReadData( lRot, pEvaluateInfo );

            mHardware.WritePos( lPos );
            mHardware.WriteRot( lRot );

            AckOneSampleReceived();
        }
        break;
    }

    return true;
}


/************************************************
 *  Real-Time Synchronous Device IO.
 ************************************************/
void ORDeviceOutput::DeviceIONotify( kDeviceIOs  pAction,FBDeviceNotifyInfo &pDeviceNotifyInfo)
{
    FBTime lEvalTime;
    switch (pAction)
    {
        // Output devices
        case kIOPlayModeWrite:
        case kIOStopModeWrite:
        {
            lEvalTime = pDeviceNotifyInfo.GetSystemTime();
            mHardware.SendDataPacket( lEvalTime );
        }
        break;
        // Input devices
        case kIOStopModeRead:
        case kIOPlayModeRead:
        {
        }
        break;
    }
}


//--- FBX load/save tags
#define FBX_TAG_SECTION     ORDEVICEOUTPUT__CLASSSTR
#define FBX_TAG_SERIALPORT  "SerialPort"

/************************************************
 *  Store data in FBX.
 ************************************************/
bool ORDeviceOutput::FbxStore(FBFbxObject* pFbxObject,kFbxObjectStore pStoreWhat)
{
    if (pStoreWhat & kAttributes)
    {
        // serial port
    }
    return true;
}


/************************************************
 *  Retrieve data from FBX.
 ************************************************/
bool ORDeviceOutput::FbxRetrieve(FBFbxObject* pFbxObject,kFbxObjectStore pStoreWhat)
{
    if (pStoreWhat & kAttributes)
    {
        // serial port
    }
    return true;
}