xsi_time.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSITIME_H__
#define __XSITIME_H__


#include "sicppsdk.h"
#include "xsi_string.h"

namespace XSI {


//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL CTime
{
public:
        enum Format
        {
                NTSC,           
                PAL,            
                FILM,           
                CUSTOM          
        };

        enum Unit
        {
                Frames,          
                Hours,           
                Minutes,         
                Seconds,         
                Milliseconds 
        };

        CTime();

        CTime(double in_time);

        CTime(double in_time, Format in_format, double in_customrate = 1.0);

        CTime(double in_time, CTime::Unit in_units, Format in_format, double in_customrate = 1.0);

        CTime(const CTime& in_time);

        ~CTime();

        double GetTime(Unit in_units = CTime::Frames ) const;

        void PutTime(double in_time, CTime::Unit units = CTime::Frames );

        CTime::Format GetFormat(void) const;

        double GetFrameRate(void) const;

        void PutFormat(CTime::Format in_format, double in_customrate = 1.0 );

        CString GetAsText(void) const;

        void SetAsText(const CString& in_str);

        CTime& operator= ( const CTime& in_time );

        CTime& operator= ( double in_time );

        bool  operator== ( const CTime& rhs ) const;

        bool  operator== ( const double rhs ) const;

        bool  operator!= ( const CTime& rhs ) const;

        bool  operator!= ( const double rhs ) const;

    operator double() const ;

        CTime Round() const;

        static CTime::Format ConvertFromPlayControlFormat( const long lFormat );

        static LONG ConvertToPlayControlFormat( const CTime::Format eFormat );

private:
        void* m_pvoid;
};

SICPPSDKDECL bool  operator== ( const double lhs, const CTime& rhs);

SICPPSDKDECL bool  operator!= ( const double lhs, const CTime& rhs);

//*************************************************************************
//*************************************************************************
class SICPPSDKDECL CTimeArray
{
public:
        CTimeArray( LONG in_size=0);

        CTimeArray(const CTimeArray& in_array);

        ~CTimeArray();

        CTimeArray& operator=( const CTimeArray& in_array );

        LONG GetCount() const;

        CStatus Add( const CTime& in_item );

        CStatus Clear();

        CStatus Resize( LONG in_size);

        const CTime& operator[]( LONG in_index ) const;

        CTime& operator[]( LONG in_index );

        bool operator==(const CTimeArray& in_array) const;

        bool operator!=(const CTimeArray& in_array) const;

private:

        void* m_ptr;
};


};

#endif // __XSITIME_H__