ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
TGLAutoRotator Class Reference

Automatically rotates GL camera.

W's are angular velocities.

Can also save images automatically.

fGUIOutMode is used internally between TGLAutoRotator and TGLViewerEditor, allowed values are:

  1. animated gif
  2. a series of png images

Definition at line 23 of file TGLAutoRotator.h.

Public Member Functions

 TGLAutoRotator (TGLViewer *v)
 Constructor. More...
 
virtual ~TGLAutoRotator ()
 Destructor. More...
 
TGLViewerGetViewer () const
 
TGLCameraGetCamera () const
 
void Start ()
 Start the auto-rotator. More...
 
void Stop ()
 Stop the auto-rotator. More...
 
void Timeout ()
 Called on every timer timeout. More...
 
void RotateScene ()
 "Scene rotation": either find a special object, which will be an axis of rotation (it's Z actually) or use a "global" Z axis. More...
 
Bool_t IsRunning () const
 
Bool_t GetRotateScene () const
 
void SetRotateScene (Bool_t rotateScene)
 
Double_t GetDeltaPhi () const
 
void SetDeltaPhi (Double_t dPhi)
 
Double_t GetDt () const
 
void SetDt (Double_t dt)
 Set time between two redraws in seconds. More...
 
Double_t GetWPhi () const
 
void SetWPhi (Double_t w)
 
Double_t GetWTheta () const
 
void SetWTheta (Double_t w)
 
Double_t GetATheta () const
 
void SetATheta (Double_t a)
 Set relative amplitude of theta oscillation. More...
 
Double_t GetWDolly () const
 
void SetWDolly (Double_t w)
 
Double_t GetADolly () const
 
void SetADolly (Double_t a)
 Set relative amplitude of forward/backward oscillation. More...
 
TString GetImageName () const
 
void SetImageName (const TString &name)
 
Int_t GetImageCount () const
 
void SetImageCount (Int_t ic)
 
Bool_t GetImageAutoSave () const
 
void SetImageAutoSave (Bool_t s)
 
void StartImageAutoSaveAnimatedGif (const TString &filename)
 Start saving into animated gif. More...
 
void StartImageAutoSave (const TString &filename)
 Start saving into a set of images. More...
 
void StopImageAutoSave ()
 Stops automatic saving of images. More...
 
TString GetImageGUIBaseName () const
 
void SetImageGUIBaseName (const TString &gname)
 
Int_t GetImageGUIOutMode () const
 
void SetImageGUIOutMode (Int_t m)
 Set output mode for GUI operation: 1 - animated gif; 2 - a series of pngs. More...
 
void StartImageAutoSaveWithGUISettings ()
 Start auto-saving images as set-up via GUI. More...
 
 ClassDef (TGLAutoRotator, 0)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Attributes

TGLViewerfViewer
 
TGLCamerafCamera
 
TTimerfTimer
 
TStopwatchfWatch
 
Bool_t fRotateScene
 
Double_t fDeltaPhi
 
Double_t fDt
 
Double_t fWPhi
 
Double_t fWTheta
 
Double_t fATheta
 
Double_t fWDolly
 
Double_t fADolly
 
Double_t fThetaA0
 
Double_t fDollyA0
 
Bool_t fTimerRunning
 
TString fImageName
 
Int_t fImageCount
 
Bool_t fImageAutoSave
 
TString fImageGUIBaseName
 
Int_t fImageGUIOutMode
 

Private Member Functions

 TGLAutoRotator (const TGLAutoRotator &)
 
TGLAutoRotatoroperator= (const TGLAutoRotator &)
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TGLAutoRotator.h>

+ Inheritance diagram for TGLAutoRotator:
+ Collaboration diagram for TGLAutoRotator:

Constructor & Destructor Documentation

TGLAutoRotator::TGLAutoRotator ( const TGLAutoRotator )
private
TGLAutoRotator::TGLAutoRotator ( TGLViewer v)

Constructor.

Definition at line 45 of file TGLAutoRotator.cxx.

TGLAutoRotator::~TGLAutoRotator ( )
virtual

Destructor.

Definition at line 64 of file TGLAutoRotator.cxx.

Member Function Documentation

TGLAutoRotator::ClassDef ( TGLAutoRotator  ,
 
)
Double_t TGLAutoRotator::GetADolly ( ) const
inline

Definition at line 92 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Double_t TGLAutoRotator::GetATheta ( ) const
inline

Definition at line 87 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

TGLCamera* TGLAutoRotator::GetCamera ( ) const
inline

Definition at line 59 of file TGLAutoRotator.h.

Referenced by TGLViewer::SetCurrentCamera().

Double_t TGLAutoRotator::GetDeltaPhi ( ) const
inline

Definition at line 76 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Double_t TGLAutoRotator::GetDt ( ) const
inline

Definition at line 79 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Bool_t TGLAutoRotator::GetImageAutoSave ( ) const
inline
Int_t TGLAutoRotator::GetImageCount ( ) const
inline

Definition at line 97 of file TGLAutoRotator.h.

TString TGLAutoRotator::GetImageGUIBaseName ( ) const
inline

Definition at line 106 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Int_t TGLAutoRotator::GetImageGUIOutMode ( ) const
inline

Definition at line 109 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

TString TGLAutoRotator::GetImageName ( ) const
inline

Definition at line 95 of file TGLAutoRotator.h.

Bool_t TGLAutoRotator::GetRotateScene ( ) const
inline

Definition at line 73 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

TGLViewer* TGLAutoRotator::GetViewer ( ) const
inline

Definition at line 58 of file TGLAutoRotator.h.

Double_t TGLAutoRotator::GetWDolly ( ) const
inline

Definition at line 90 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Double_t TGLAutoRotator::GetWPhi ( ) const
inline

Definition at line 82 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Double_t TGLAutoRotator::GetWTheta ( ) const
inline

Definition at line 85 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::SetModel().

Bool_t TGLAutoRotator::IsRunning ( ) const
inline
TGLAutoRotator& TGLAutoRotator::operator= ( const TGLAutoRotator )
private
void TGLAutoRotator::RotateScene ( )

"Scene rotation": either find a special object, which will be an axis of rotation (it's Z actually) or use a "global" Z axis.

Definition at line 286 of file TGLAutoRotator.cxx.

Referenced by Timeout().

void TGLAutoRotator::SetADolly ( Double_t  a)

Set relative amplitude of forward/backward oscillation.

Value range: 0.01 -> 1.

Definition at line 102 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetATheta ( Double_t  a)

Set relative amplitude of theta oscillation.

Value range: 0.01 -> 1.

Definition at line 88 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetDeltaPhi ( Double_t  dPhi)
inline

Definition at line 77 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetDt ( Double_t  dt)

Set time between two redraws in seconds.

Range: 0.001 -> 1.

Definition at line 74 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetImageAutoSave ( Bool_t  s)
inline

Definition at line 100 of file TGLAutoRotator.h.

void TGLAutoRotator::SetImageCount ( Int_t  ic)
inline

Definition at line 98 of file TGLAutoRotator.h.

void TGLAutoRotator::SetImageGUIBaseName ( const TString gname)
inline

Definition at line 107 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::DoASavImageGUIBaseName().

void TGLAutoRotator::SetImageGUIOutMode ( Int_t  m)

Set output mode for GUI operation: 1 - animated gif; 2 - a series of pngs.

Definition at line 250 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::DoASavImageGUIOutMode().

void TGLAutoRotator::SetImageName ( const TString name)
inline

Definition at line 96 of file TGLAutoRotator.h.

void TGLAutoRotator::SetRotateScene ( Bool_t  rotateScene)
inline

Definition at line 74 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::DoRotatorStart().

void TGLAutoRotator::SetWDolly ( Double_t  w)
inline

Definition at line 91 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetWPhi ( Double_t  w)
inline

Definition at line 83 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::SetWTheta ( Double_t  w)
inline

Definition at line 86 of file TGLAutoRotator.h.

Referenced by TGLViewerEditor::UpdateRotator().

void TGLAutoRotator::Start ( )

Start the auto-rotator.

Definition at line 115 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::DoRotatorStart(), and TGLViewer::SetCurrentCamera().

void TGLAutoRotator::StartImageAutoSave ( const TString filename)

Start saving into a set of images.

The provided name will be used as a format to insert additional image sequence number so it should include an '' character. A good name would be something like: "image-%04d.png" On GNU/Linux use mencoder and/or ffmpeg to bundle images into a movie.

Definition at line 224 of file TGLAutoRotator.cxx.

Referenced by StartImageAutoSaveWithGUISettings().

void TGLAutoRotator::StartImageAutoSaveAnimatedGif ( const TString filename)

Start saving into animated gif.

The provided name will be used as it is, so make sure to end it with '.gif+'. Use convert tool from ImageMagic if you want to set a different delay or enable looping.

Definition at line 204 of file TGLAutoRotator.cxx.

Referenced by StartImageAutoSaveWithGUISettings().

void TGLAutoRotator::StartImageAutoSaveWithGUISettings ( )

Start auto-saving images as set-up via GUI.

Definition at line 263 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::DoASavImageStart().

void TGLAutoRotator::Stop ( )

Stop the auto-rotator.

Definition at line 137 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::DoRotatorStop(), TGLViewer::SetCurrentCamera(), SetRotateScene(), and Start().

void TGLAutoRotator::StopImageAutoSave ( )

Stops automatic saving of images.

Definition at line 240 of file TGLAutoRotator.cxx.

Referenced by TGLViewerEditor::DoASavImageStop().

void TGLAutoRotator::Timeout ( )

Called on every timer timeout.

Moves / rotates the camera and optionally produces a screenshot.

Definition at line 151 of file TGLAutoRotator.cxx.

Member Data Documentation

Double_t TGLAutoRotator::fADolly
protected

Definition at line 42 of file TGLAutoRotator.h.

Referenced by GetADolly(), SetADolly(), and Start().

Double_t TGLAutoRotator::fATheta
protected

Definition at line 41 of file TGLAutoRotator.h.

Referenced by GetATheta(), SetATheta(), and Start().

TGLCamera* TGLAutoRotator::fCamera
protected

Definition at line 31 of file TGLAutoRotator.h.

Referenced by GetCamera(), Start(), and Timeout().

Double_t TGLAutoRotator::fDeltaPhi
protected

Definition at line 37 of file TGLAutoRotator.h.

Referenced by GetDeltaPhi(), and RotateScene().

Double_t TGLAutoRotator::fDollyA0
protected

Definition at line 44 of file TGLAutoRotator.h.

Referenced by SetADolly(), Start(), and Timeout().

Double_t TGLAutoRotator::fDt
protected

Definition at line 39 of file TGLAutoRotator.h.

Referenced by GetDt(), SetDt(), Start(), and Timeout().

Bool_t TGLAutoRotator::fImageAutoSave
protected
Int_t TGLAutoRotator::fImageCount
protected
TString TGLAutoRotator::fImageGUIBaseName
protected

Definition at line 51 of file TGLAutoRotator.h.

Referenced by GetImageGUIBaseName(), and StartImageAutoSaveWithGUISettings().

Int_t TGLAutoRotator::fImageGUIOutMode
protected
TString TGLAutoRotator::fImageName
protected
Bool_t TGLAutoRotator::fRotateScene
protected

Definition at line 35 of file TGLAutoRotator.h.

Referenced by GetRotateScene(), and Timeout().

Double_t TGLAutoRotator::fThetaA0
protected

Definition at line 44 of file TGLAutoRotator.h.

Referenced by SetATheta(), Start(), and Timeout().

TTimer* TGLAutoRotator::fTimer
protected

Definition at line 32 of file TGLAutoRotator.h.

Referenced by SetDt(), Start(), Stop(), TGLAutoRotator(), Timeout(), and ~TGLAutoRotator().

Bool_t TGLAutoRotator::fTimerRunning
protected

Definition at line 45 of file TGLAutoRotator.h.

Referenced by IsRunning(), SetADolly(), SetATheta(), SetDt(), Start(), Stop(), and Timeout().

TGLViewer* TGLAutoRotator::fViewer
protected

Definition at line 30 of file TGLAutoRotator.h.

Referenced by GetViewer(), RotateScene(), Start(), and Timeout().

TStopwatch* TGLAutoRotator::fWatch
protected

Definition at line 33 of file TGLAutoRotator.h.

Referenced by Start(), Stop(), Timeout(), and ~TGLAutoRotator().

Double_t TGLAutoRotator::fWDolly
protected

Definition at line 42 of file TGLAutoRotator.h.

Referenced by GetWDolly(), and Timeout().

Double_t TGLAutoRotator::fWPhi
protected

Definition at line 40 of file TGLAutoRotator.h.

Referenced by GetWPhi(), and Timeout().

Double_t TGLAutoRotator::fWTheta
protected

Definition at line 41 of file TGLAutoRotator.h.

Referenced by GetWTheta(), and Timeout().


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