HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
HUSD_TimeCode Class Reference

#include <HUSD_TimeCode.h>

Public Types

enum  TimeFormat { TIME, FRAME }
 

Public Member Functions

 HUSD_TimeCode ()
 
 HUSD_TimeCode (fpreal frame, bool is_default=false)
 
 HUSD_TimeCode (fpreal time, TimeFormat format, bool is_default=false)
 
HUSD_TimeCode getNonDefaultTimeCode () const
 
bool operator== (const HUSD_TimeCode &other) const
 
bool operator!= (const HUSD_TimeCode &other) const
 
fpreal time () const
 
fpreal frame () const
 
bool isDefault () const
 

Detailed Description

Examples:
LOP/XUSD_TrueAutoCollection.C, and LOP/XUSD_TrueAutoCollection.h.

Definition at line 24 of file HUSD_TimeCode.h.

Member Enumeration Documentation

enum HUSD_TimeCode::TimeFormat
Enumerator
TIME 
FRAME 

Definition at line 27 of file HUSD_TimeCode.h.

Constructor & Destructor Documentation

HUSD_TimeCode::HUSD_TimeCode ( )
inline

Definition at line 34 of file HUSD_TimeCode.h.

HUSD_TimeCode::HUSD_TimeCode ( fpreal  frame,
bool  is_default = false 
)
inlineexplicit

Definition at line 42 of file HUSD_TimeCode.h.

HUSD_TimeCode::HUSD_TimeCode ( fpreal  time,
TimeFormat  format,
bool  is_default = false 
)
explicit

Member Function Documentation

fpreal HUSD_TimeCode::frame ( ) const
inline

Definition at line 69 of file HUSD_TimeCode.h.

HUSD_TimeCode HUSD_TimeCode::getNonDefaultTimeCode ( ) const
inline

Returns a time code with the same specific time/frame as this one, but whose default flag is cleared. This is needed for cases where a default time is not acceptable (such as when setting a time-varying attribute on a stage).

Definition at line 59 of file HUSD_TimeCode.h.

bool HUSD_TimeCode::isDefault ( ) const
inline

Definition at line 71 of file HUSD_TimeCode.h.

bool HUSD_TimeCode::operator!= ( const HUSD_TimeCode &  other) const
inline

Definition at line 65 of file HUSD_TimeCode.h.

bool HUSD_TimeCode::operator== ( const HUSD_TimeCode &  other) const
inline

Definition at line 62 of file HUSD_TimeCode.h.

fpreal HUSD_TimeCode::time ( ) const
The documentation for this class was generated from the following file: