HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GU_MotionClipTimeMap Class Reference

Mapper class for conversion between clip and scene time (in seconds) More...

#include <GU_MotionClipUtil.h>

Public Member Functions

void reset ()
 Reset to the default scene's global range, unclamped. More...
 
void trimRange (fpreal start, fpreal end)
 Trim the current range to the given (assumes we have valid range) More...
 
bool hasInvalidRange () const
 Returns true when we have both start/end and start > end. More...
 
fpreal toSceneSeconds (fpreal clip_seconds) const
 Convert from clip time to scene time. More...
 
fpreal toClipSeconds (fpreal scene_seconds) const
 Convert from scene time to clip time. More...
 
fpreal clampClipSeconds (fpreal clip_seconds) const
 Clamp clip time depending to available clip range. More...
 
fpreal start () const
 
void setStart (fpreal v, bool clamp=true)
 
void setClampedStart (fpreal v, bool clamp=true)
 This variant will first clamp v to existing parameters. More...
 
fpreal end () const
 
void setEnd (fpreal v, bool clamp=true)
 
void setClampedEnd (fpreal v, bool clamp=true)
 This variant will first clamp v to existing parameters. More...
 
fpreal playbackStart () const
 
void setPlaybackStart (fpreal v)
 
fpreal speed () const
 
void setSpeed (fpreal v)
 

Detailed Description

Mapper class for conversion between clip and scene time (in seconds)

Definition at line 53 of file GU_MotionClipUtil.h.

Member Function Documentation

fpreal GU_MotionClipTimeMap::clampClipSeconds ( fpreal  clip_seconds) const
inline

Clamp clip time depending to available clip range.

Definition at line 282 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::end ( void  ) const
inline

End time to clamp to in clip seconds

Definition at line 73 of file GU_MotionClipUtil.h.

bool GU_MotionClipTimeMap::hasInvalidRange ( ) const
inline

Returns true when we have both start/end and start > end.

Definition at line 86 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::playbackStart ( ) const
inline

Playback start time in scene seconds

Definition at line 90 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::reset ( )
inline

Reset to the default scene's global range, unclamped.

Definition at line 58 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setClampedEnd ( fpreal  v,
bool  clamp = true 
)
inline

This variant will first clamp v to existing parameters.

Definition at line 78 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setClampedStart ( fpreal  v,
bool  clamp = true 
)
inline

This variant will first clamp v to existing parameters.

Definition at line 67 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setEnd ( fpreal  v,
bool  clamp = true 
)
inline

End time to clamp to in clip seconds

Definition at line 75 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setPlaybackStart ( fpreal  v)
inline

Playback start time in scene seconds

Definition at line 91 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setSpeed ( fpreal  v)
inline

Speed at which to playback in the scene

Definition at line 97 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::setStart ( fpreal  v,
bool  clamp = true 
)
inline

Start time in clip seconds

Definition at line 64 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::speed ( ) const
inline

Speed at which to playback in the scene

Definition at line 96 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::start ( ) const
inline

Start time in clip seconds

Definition at line 62 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::toClipSeconds ( fpreal  scene_seconds) const
inline

Convert from scene time to clip time.

Definition at line 300 of file GU_MotionClipUtil.h.

fpreal GU_MotionClipTimeMap::toSceneSeconds ( fpreal  clip_seconds) const
inline

Convert from clip time to scene time.

Definition at line 293 of file GU_MotionClipUtil.h.

void GU_MotionClipTimeMap::trimRange ( fpreal  start,
fpreal  end 
)
inline

Trim the current range to the given (assumes we have valid range)

Definition at line 273 of file GU_MotionClipUtil.h.


The documentation for this class was generated from the following file: