Logo ROOT  
Reference Guide
TGLAutoRotator Class Reference

Automatically rotates GL camera.

W's are angular velocities.

  • ATheta – Theta amplitude in units of Pi/2.
  • ADolly – In/out amplitude in units of initial distance.

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...
 
Double_t GetADolly () const
 
Double_t GetATheta () const
 
TGLCameraGetCamera () const
 
Double_t GetDeltaPhi () const
 
Double_t GetDt () const
 
Bool_t GetImageAutoSave () const
 
Int_t GetImageCount () const
 
TString GetImageGUIBaseName () const
 
Int_t GetImageGUIOutMode () const
 
TString GetImageName () const
 
Bool_t GetRotateScene () const
 
TGLViewerGetViewer () const
 
Double_t GetWDolly () const
 
Double_t GetWPhi () const
 
Double_t GetWTheta () const
 
Bool_t IsRunning () const
 
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...
 
void SetADolly (Double_t a)
 Set relative amplitude of forward/backward oscillation. More...
 
void SetATheta (Double_t a)
 Set relative amplitude of theta oscillation. More...
 
void SetDeltaPhi (Double_t dPhi)
 
void SetDt (Double_t dt)
 Set time between two redraws in seconds. More...
 
void SetImageAutoSave (Bool_t s)
 
void SetImageCount (Int_t ic)
 
void SetImageGUIBaseName (const TString &gname)
 
void SetImageGUIOutMode (Int_t m)
 Set output mode for GUI operation: 1 - animated gif; 2 - a series of pngs. More...
 
void SetImageName (const TString &name)
 
void SetRotateScene (Bool_t rotateScene)
 
void SetWDolly (Double_t w)
 
void SetWPhi (Double_t w)
 
void SetWTheta (Double_t w)
 
void Start ()
 Start the auto-rotator. More...
 
void StartImageAutoSave (const TString &filename)
 Start saving into a set of images. More...
 
void StartImageAutoSaveAnimatedGif (const TString &filename)
 Start saving into animated gif. More...
 
void StartImageAutoSaveWithGUISettings ()
 Start auto-saving images as set-up via GUI. More...
 
void Stop ()
 Stop the auto-rotator. More...
 
void StopImageAutoSave ()
 Stops automatic saving of images. More...
 
void Timeout ()
 Called on every timer timeout. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. 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...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
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 void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Attributes

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

Private Member Functions

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

Additional Inherited Members

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

#include <TGLAutoRotator.h>

Inheritance diagram for TGLAutoRotator:
[legend]

Constructor & Destructor Documentation

◆ TGLAutoRotator() [1/2]

TGLAutoRotator::TGLAutoRotator ( const TGLAutoRotator )
private

◆ TGLAutoRotator() [2/2]

TGLAutoRotator::TGLAutoRotator ( TGLViewer v)

Constructor.

Definition at line 45 of file TGLAutoRotator.cxx.

◆ ~TGLAutoRotator()

TGLAutoRotator::~TGLAutoRotator ( )
virtual

Destructor.

Definition at line 64 of file TGLAutoRotator.cxx.

Member Function Documentation

◆ GetADolly()

Double_t TGLAutoRotator::GetADolly ( ) const
inline

Definition at line 92 of file TGLAutoRotator.h.

◆ GetATheta()

Double_t TGLAutoRotator::GetATheta ( ) const
inline

Definition at line 87 of file TGLAutoRotator.h.

◆ GetCamera()

TGLCamera* TGLAutoRotator::GetCamera ( ) const
inline

Definition at line 59 of file TGLAutoRotator.h.

◆ GetDeltaPhi()

Double_t TGLAutoRotator::GetDeltaPhi ( ) const
inline

Definition at line 76 of file TGLAutoRotator.h.

◆ GetDt()

Double_t TGLAutoRotator::GetDt ( ) const
inline

Definition at line 79 of file TGLAutoRotator.h.

◆ GetImageAutoSave()

Bool_t TGLAutoRotator::GetImageAutoSave ( ) const
inline

Definition at line 99 of file TGLAutoRotator.h.

◆ GetImageCount()

Int_t TGLAutoRotator::GetImageCount ( ) const
inline

Definition at line 97 of file TGLAutoRotator.h.

◆ GetImageGUIBaseName()

TString TGLAutoRotator::GetImageGUIBaseName ( ) const
inline

Definition at line 106 of file TGLAutoRotator.h.

◆ GetImageGUIOutMode()

Int_t TGLAutoRotator::GetImageGUIOutMode ( ) const
inline

Definition at line 109 of file TGLAutoRotator.h.

◆ GetImageName()

TString TGLAutoRotator::GetImageName ( ) const
inline

Definition at line 95 of file TGLAutoRotator.h.

◆ GetRotateScene()

Bool_t TGLAutoRotator::GetRotateScene ( ) const
inline

Definition at line 73 of file TGLAutoRotator.h.

◆ GetViewer()

TGLViewer* TGLAutoRotator::GetViewer ( ) const
inline

Definition at line 58 of file TGLAutoRotator.h.

◆ GetWDolly()

Double_t TGLAutoRotator::GetWDolly ( ) const
inline

Definition at line 90 of file TGLAutoRotator.h.

◆ GetWPhi()

Double_t TGLAutoRotator::GetWPhi ( ) const
inline

Definition at line 82 of file TGLAutoRotator.h.

◆ GetWTheta()

Double_t TGLAutoRotator::GetWTheta ( ) const
inline

Definition at line 85 of file TGLAutoRotator.h.

◆ IsRunning()

Bool_t TGLAutoRotator::IsRunning ( ) const
inline

Definition at line 71 of file TGLAutoRotator.h.

◆ operator=()

TGLAutoRotator& TGLAutoRotator::operator= ( const TGLAutoRotator )
private

◆ RotateScene()

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.

◆ SetADolly()

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.

◆ SetATheta()

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.

◆ SetDeltaPhi()

void TGLAutoRotator::SetDeltaPhi ( Double_t  dPhi)
inline

Definition at line 77 of file TGLAutoRotator.h.

◆ SetDt()

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.

◆ SetImageAutoSave()

void TGLAutoRotator::SetImageAutoSave ( Bool_t  s)
inline

Definition at line 100 of file TGLAutoRotator.h.

◆ SetImageCount()

void TGLAutoRotator::SetImageCount ( Int_t  ic)
inline

Definition at line 98 of file TGLAutoRotator.h.

◆ SetImageGUIBaseName()

void TGLAutoRotator::SetImageGUIBaseName ( const TString gname)
inline

Definition at line 107 of file TGLAutoRotator.h.

◆ SetImageGUIOutMode()

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.

◆ SetImageName()

void TGLAutoRotator::SetImageName ( const TString name)
inline

Definition at line 96 of file TGLAutoRotator.h.

◆ SetRotateScene()

void TGLAutoRotator::SetRotateScene ( Bool_t  rotateScene)
inline

Definition at line 74 of file TGLAutoRotator.h.

◆ SetWDolly()

void TGLAutoRotator::SetWDolly ( Double_t  w)
inline

Definition at line 91 of file TGLAutoRotator.h.

◆ SetWPhi()

void TGLAutoRotator::SetWPhi ( Double_t  w)
inline

Definition at line 83 of file TGLAutoRotator.h.

◆ SetWTheta()

void TGLAutoRotator::SetWTheta ( Double_t  w)
inline

Definition at line 86 of file TGLAutoRotator.h.

◆ Start()

void TGLAutoRotator::Start ( )

Start the auto-rotator.

Definition at line 115 of file TGLAutoRotator.cxx.

◆ StartImageAutoSave()

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.

◆ StartImageAutoSaveAnimatedGif()

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.

◆ StartImageAutoSaveWithGUISettings()

void TGLAutoRotator::StartImageAutoSaveWithGUISettings ( )

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

Definition at line 263 of file TGLAutoRotator.cxx.

◆ Stop()

void TGLAutoRotator::Stop ( )

Stop the auto-rotator.

Definition at line 137 of file TGLAutoRotator.cxx.

◆ StopImageAutoSave()

void TGLAutoRotator::StopImageAutoSave ( )

Stops automatic saving of images.

Definition at line 240 of file TGLAutoRotator.cxx.

◆ Timeout()

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

◆ fADolly

Double_t TGLAutoRotator::fADolly
protected

Definition at line 42 of file TGLAutoRotator.h.

◆ fATheta

Double_t TGLAutoRotator::fATheta
protected

Definition at line 41 of file TGLAutoRotator.h.

◆ fCamera

TGLCamera* TGLAutoRotator::fCamera
protected

Definition at line 31 of file TGLAutoRotator.h.

◆ fDeltaPhi

Double_t TGLAutoRotator::fDeltaPhi
protected

Definition at line 37 of file TGLAutoRotator.h.

◆ fDollyA0

Double_t TGLAutoRotator::fDollyA0
protected

Definition at line 44 of file TGLAutoRotator.h.

◆ fDt

Double_t TGLAutoRotator::fDt
protected

Definition at line 39 of file TGLAutoRotator.h.

◆ fImageAutoSave

Bool_t TGLAutoRotator::fImageAutoSave
protected

Definition at line 49 of file TGLAutoRotator.h.

◆ fImageCount

Int_t TGLAutoRotator::fImageCount
protected

Definition at line 48 of file TGLAutoRotator.h.

◆ fImageGUIBaseName

TString TGLAutoRotator::fImageGUIBaseName
protected

Definition at line 51 of file TGLAutoRotator.h.

◆ fImageGUIOutMode

Int_t TGLAutoRotator::fImageGUIOutMode
protected

Definition at line 52 of file TGLAutoRotator.h.

◆ fImageName

TString TGLAutoRotator::fImageName
protected

Definition at line 47 of file TGLAutoRotator.h.

◆ fRotateScene

Bool_t TGLAutoRotator::fRotateScene
protected

Definition at line 35 of file TGLAutoRotator.h.

◆ fThetaA0

Double_t TGLAutoRotator::fThetaA0
protected

Definition at line 44 of file TGLAutoRotator.h.

◆ fTimer

TTimer* TGLAutoRotator::fTimer
protected

Definition at line 32 of file TGLAutoRotator.h.

◆ fTimerRunning

Bool_t TGLAutoRotator::fTimerRunning
protected

Definition at line 45 of file TGLAutoRotator.h.

◆ fViewer

TGLViewer* TGLAutoRotator::fViewer
protected

Definition at line 30 of file TGLAutoRotator.h.

◆ fWatch

TStopwatch* TGLAutoRotator::fWatch
protected

Definition at line 33 of file TGLAutoRotator.h.

◆ fWDolly

Double_t TGLAutoRotator::fWDolly
protected

Definition at line 42 of file TGLAutoRotator.h.

◆ fWPhi

Double_t TGLAutoRotator::fWPhi
protected

Definition at line 40 of file TGLAutoRotator.h.

◆ fWTheta

Double_t TGLAutoRotator::fWTheta
protected

Definition at line 41 of file TGLAutoRotator.h.

Libraries for TGLAutoRotator:
[legend]

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