Logo ROOT   6.14/05
Reference Guide
List of all members | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
TGLPerspectiveCamera Class Reference

Perspective projection camera - with characteristic foreshortening.

Definition at line 25 of file TGLPerspectiveCamera.h.

Public Member Functions

 TGLPerspectiveCamera ()
 Construct default XOZ perspective camera. More...
 
 TGLPerspectiveCamera (const TGLVector3 &hAxis, const TGLVector3 &vAxis)
 Construct perspective camera. More...
 
virtual ~TGLPerspectiveCamera ()
 Destroy perspective camera. More...
 
virtual void Apply (const TGLBoundingBox &box, const TGLRect *pickRect=0) const
 Apply the camera to the current GL context, setting the viewport, projection and modelview matrices. More...
 
virtual void Configure (Double_t fov, Double_t dolly, Double_t center[3], Double_t hRotate, Double_t vRotate)
 Configure the camera state. More...
 
Double_t GetFOV () const
 
virtual Bool_t IsPerspective () const
 
virtual void Reset ()
 Reset the camera to defaults - reframe the world volume established in Setup() in default state. More...
 
void SetFOV (Double_t fov)
 
virtual void Setup (const TGLBoundingBox &box, Bool_t reset=kTRUE)
 Setup camera limits suitable to view the world volume defined by 'box' and call Reset() to initialise camera. More...
 
virtual Bool_t Truck (Int_t xDelta, Int_t yDelta, Bool_t mod1, Bool_t mod2)
 Truck the camera - 'move camera parallel to film plane'. More...
 
virtual Bool_t Zoom (Int_t delta, Bool_t mod1, Bool_t mod2)
 Zoom the camera - 'adjust lens focal length, retaining camera position'. More...
 
- Public Member Functions inherited from TGLCamera
 TGLCamera ()
 Default base camera constructor. More...
 
 TGLCamera (const TGLVector3 &hAxis, const TGLVector3 &vAxis)
 Default base camera constructor. More...
 
virtual ~TGLCamera ()
 Base camera destructor. More...
 
Bool_t AdjustAndClampVal (Double_t &val, Double_t min, Double_t max, Int_t screenShift, Int_t screenShiftRange, Bool_t mod1, Bool_t mod2) const
 Adjust a passed REFERENCE value 'val', based on screenShift delta. More...
 
Double_t AdjustDelta (Double_t screenShift, Double_t deltaFactor, Bool_t mod1, Bool_t mod2) const
 Adjust a passed screen value and apply modifiers. More...
 
virtual Bool_t Dolly (Int_t delta, Bool_t mod1, Bool_t mod2)
 Dolly the camera - 'move camera along eye line, retaining lens focal length'. More...
 
void DrawDebugAids () const
 Draw out some debugging aids for the camera: More...
 
TGLVector3 EyeDirection () const
 Extract the camera eye direction (vector), running from EyePoint() Camera must have valid frustum cache - call Apply() after last modification, before using. More...
 
TGLVertex3 EyePoint () const
 Return the camera eye point (vertex) in world space Camera must have valid frustum cache - call Apply() after last modification, before using. More...
 
TGLVertex3 FrustumCenter () const
 Find the center of the camera frustum from intersection of planes This method will work even with parallel left/right & top/bottom and infinite eye point of ortho cameras Camera must have valid frustum cache - call Apply() after last modification, before using. More...
 
Rgl::EOverlap FrustumOverlap (const TGLBoundingBox &box) const
 Calculate overlap (kInside, kOutside, kPartial) of box with camera frustum Camera must have valid frustum cache - call Apply() after last modification, before using. More...
 
const TGLPlaneFrustumPlane (EFrustumPlane plane) const
 
const TGLMatrixGetCamBase () const
 
const TGLMatrixGetCamTrans () const
 
Double_tGetCenterVec ()
 
Bool_t GetExternalCenter ()
 
Double_t GetFarClip () const
 
Double_tGetFixDefCenterVec ()
 
Double_t GetNearClip () const
 
Double_t GetTheta () const
 Get angle between camera up axis. More...
 
Float_t GetVAxisMinAngle ()
 
void IncTimeStamp ()
 
Bool_t IsCacheDirty () const
 
virtual Bool_t IsOrthographic () const
 
Bool_t OfInterest (const TGLBoundingBox &box, Bool_t ignoreSize) const
 Calculate if the an object defined by world frame bounding box is 'of interest' to the camera. More...
 
TGLMatrixRefCamBase ()
 
TGLMatrixRefCamTrans ()
 
TGLMatrixRefLastNoPickProjM () const
 
const TGLMatrixRefModelViewMatrix () const
 
TGLRectRefViewport ()
 
const TGLRectRefViewport () const
 
void ResetInterest ()
 Clear out the existing interest box. More...
 
virtual Bool_t Rotate (Int_t xDelta, Int_t yDelta, Bool_t mod1, Bool_t mod2)
 Rotate the camera round view volume center established in Setup(). More...
 
virtual Bool_t RotateArcBall (Int_t xDelta, Int_t yDelta, Bool_t mod1, Bool_t mod2)
 Rotate the camera round view volume center established in Setup(). More...
 
virtual Bool_t RotateArcBallRad (Double_t hRotate, Double_t vRotate)
 Rotate camera around center. More...
 
virtual Bool_t RotateRad (Double_t hRotate, Double_t vRotate)
 Rotate camera around center. More...
 
void SetCenterVec (Double_t x, Double_t y, Double_t z)
 Set camera center vector. More...
 
void SetCenterVecWarp (Double_t x, Double_t y, Double_t z)
 Set camera center vector and do not keep the same combined camera transformation matrix. More...
 
void SetExternalCenter (Bool_t x)
 Set camera center diffrent than scene center, if enable is kTRUE. More...
 
void SetFixDefCenter (Bool_t x)
 
void SetFixDefCenterVec (Double_t x, Double_t y, Double_t z)
 
void SetVAxisMinAngle (Float_t x)
 
void SetViewport (const TGLRect &viewport)
 Set viewport extents from passed 'viewport' rect. More...
 
UInt_t TimeStamp () const
 
virtual Bool_t Truck (Double_t xDelta, Double_t yDelta)
 Truck the camera - 'move camera parallel to film plane'. More...
 
Bool_t UpdateInterest (Bool_t force)
 Update the internal interest box (fInterestBox) of the camera. More...
 
TGLVector3 ViewportDeltaToWorld (const TGLVertex3 &worldRef, Double_t viewportXDelta, Double_t viewportYDelta, TGLMatrix *modviewMat=0) const
 Apply a 2D viewport delta (shift) to the projection of worldRef onto viewport, returning the resultant world vector which equates to it. More...
 
Rgl::EOverlap ViewportOverlap (const TGLBoundingBox &box) const
 Calculate overlap (kInside, kOutside, kPartial) of box projection onto viewport (as rect) against the viewport rect. More...
 
std::pair< Bool_t, TGLVertex3ViewportPlaneIntersection (Double_t viewportX, Double_t viewportY, const TGLPlane &worldPlane) const
 Find the intersection of projection of supplied viewport point (a 3D world line - see ViewportToWorld) with supplied world plane. More...
 
std::pair< Bool_t, TGLVertex3ViewportPlaneIntersection (const TPoint &viewport, const TGLPlane &worldPlane) const
 Find the intersection of projection of supplied viewport TPoint (a 3D world line - see ViewportToWorld) with supplied world plane. More...
 
TGLRect ViewportRect (const TGLBoundingBox &box, TGLBoundingBox::EFace face) const
 Calculate viewport rectangle which just contains projection of single 'face' of world frame bounding box 'box' onto the viewport. More...
 
TGLRect ViewportRect (const TGLBoundingBox &box, const TGLBoundingBox::EFace *face=0) const
 Calculate viewport rectangle which just contains projection of world frame bounding box 'box' onto the viewport. More...
 
TGLVertex3 ViewportToWorld (const TGLVertex3 &viewportVertex, TGLMatrix *modviewMat=0) const
 Convert a '3D' viewport vertex to 3D world one. More...
 
TGLLine3 ViewportToWorld (Double_t viewportX, Double_t viewportY) const
 Convert a 2D viewport position to 3D world line - the projection of the viewport point into 3D space. More...
 
TGLLine3 ViewportToWorld (const TPoint &viewport) const
 Convert a 2D viewport position to 3D world line - the projection of the viewport point into 3D space. More...
 
void WindowToViewport (Int_t &, Int_t &y) const
 
void WindowToViewport (TPoint &point) const
 
void WindowToViewport (TGLRect &rect) const
 
void WindowToViewport (TGLVertex3 &vertex) const
 
TGLVector3 WorldDeltaToViewport (const TGLVertex3 &worldRef, const TGLVector3 &worldDelta) const
 Convert a 3D vector worldDelta (shift) about vertex worldRef to a viewport (screen) '3D' vector. More...
 
TGLVertex3 WorldToViewport (const TGLVertex3 &worldVertex, TGLMatrix *modviewMat=0) const
 Convert a 3D world vertex to '3D' viewport (screen) one. 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 ()
 Checked and record whether for 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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...
 

Private Attributes

Double_t fFOV
 

Static Private Attributes

static Double_t fgFOVDefault = 30
 
static UInt_t fgFOVDeltaSens = 500
 
static Double_t fgFOVMax = 120.0
 
static Double_t fgFOVMin = 0.01
 

Additional Inherited Members

- Public Types inherited from TGLCamera
enum  EFrustumPlane {
  kNear = 0, kLeft = 1, kRight = 2, kTop = 3,
  kBottom = 4, kFar = 5, kPlanesPerFrustum = 6
}
 
- 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 TGLCamera
void UpdateCache () const
 largest box diagonal seen in OfInterest() - used when bootstrapping interest box 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 ()
 
- Protected Attributes inherited from TGLCamera
Bool_t fCacheDirty
 
TGLMatrix fCamBase
 
TGLMatrix fCamTrans
 
TGLVector3fCenter
 
TGLMatrix fClipM
 modelView matrix (cached) More...
 
TGLVector3 fDefCenter
 
Double_t fDollyDefault
 last applied far-clip More...
 
Double_t fDollyDistance
 
TGLVector3 fExtCenter
 
Bool_t fExternalCenter
 
Double_t fFarClip
 last applied near-clip More...
 
TGLVector3 fFDCenter
 
Bool_t fFixDefCenter
 
TGLPlane fFrustumPlanes [kPlanesPerFrustum]
 object space clip matrix (cached) More...
 
TGLBoundingBox fInterestBox
 viewport (GL coords - origin bottom left) More...
 
Double_t fLargestSeen
 the interest box - created in UpdateInterest() More...
 
TGLMatrix fLastNoPickProjM
 timestamp More...
 
TGLMatrix fModVM
 projection matrix (cached) More...
 
Double_t fNearClip
 current camera center More...
 
TGLMatrix fProjM
 no-pick projection matrix (cached) More...
 
UInt_t fTimeStamp
 cached items dirty? More...
 
Float_t fVAxisMinAngle
 
TGLRect fViewport
 frustum planes (cached) More...
 
Bool_t fWasArcBalled
 
- Static Protected Attributes inherited from TGLCamera
static UInt_t fgDollyDeltaSens = 500
 

#include <TGLPerspectiveCamera.h>

Inheritance diagram for TGLPerspectiveCamera:
[legend]

Constructor & Destructor Documentation

◆ TGLPerspectiveCamera() [1/2]

TGLPerspectiveCamera::TGLPerspectiveCamera ( )

Construct default XOZ perspective camera.

Definition at line 34 of file TGLPerspectiveCamera.cxx.

◆ TGLPerspectiveCamera() [2/2]

TGLPerspectiveCamera::TGLPerspectiveCamera ( const TGLVector3 hAxis,
const TGLVector3 vAxis 
)

Construct perspective camera.

Definition at line 45 of file TGLPerspectiveCamera.cxx.

◆ ~TGLPerspectiveCamera()

TGLPerspectiveCamera::~TGLPerspectiveCamera ( )
virtual

Destroy perspective camera.

Definition at line 56 of file TGLPerspectiveCamera.cxx.

Member Function Documentation

◆ Apply()

void TGLPerspectiveCamera::Apply ( const TGLBoundingBox sceneBox,
const TGLRect pickRect = 0 
) const
virtual

Apply the camera to the current GL context, setting the viewport, projection and modelview matrices.

After this vertices etc can be directly entered in the world frame. This also updates the cached frustum values, enabling all the projection, overlap tests etc defined in TGLCamera to be used.

Arguments are:

  • 'box' - view volume box - used to adjust near/far clipping
  • 'pickRect' - optional picking rect. If non-null, restrict drawing to this viewport rect.

Implements TGLCamera.

Definition at line 158 of file TGLPerspectiveCamera.cxx.

◆ Configure()

void TGLPerspectiveCamera::Configure ( Double_t  fov,
Double_t  dolly,
Double_t  center[3],
Double_t  hRotate,
Double_t  vRotate 
)
virtual

Configure the camera state.

  • fov - set directly field-of-view in degrees (default = 30);
  • dolly - additional move along the camera forward direction;
  • center - new camera center (can be 0 for no change);
  • hRotate - additional "up/down" rotation in radians;
  • vRotate - additional "left/right" rotation in radians.

Implements TGLCamera.

Definition at line 272 of file TGLPerspectiveCamera.cxx.

◆ GetFOV()

Double_t TGLPerspectiveCamera::GetFOV ( ) const
inline

Definition at line 41 of file TGLPerspectiveCamera.h.

◆ IsPerspective()

virtual Bool_t TGLPerspectiveCamera::IsPerspective ( ) const
inlinevirtual

Reimplemented from TGLCamera.

Definition at line 39 of file TGLPerspectiveCamera.h.

◆ Reset()

void TGLPerspectiveCamera::Reset ( void  )
virtual

Reset the camera to defaults - reframe the world volume established in Setup() in default state.

Note: limits defined in Setup() are not adjusted.

Implements TGLCamera.

Definition at line 99 of file TGLPerspectiveCamera.cxx.

◆ SetFOV()

void TGLPerspectiveCamera::SetFOV ( Double_t  fov)
inline

Definition at line 42 of file TGLPerspectiveCamera.h.

◆ Setup()

void TGLPerspectiveCamera::Setup ( const TGLBoundingBox box,
Bool_t  reset = kTRUE 
)
virtual

Setup camera limits suitable to view the world volume defined by 'box' and call Reset() to initialise camera.

Implements TGLCamera.

Definition at line 64 of file TGLPerspectiveCamera.cxx.

◆ Truck()

Bool_t TGLPerspectiveCamera::Truck ( Int_t  xDelta,
Int_t  yDelta,
Bool_t  mod1,
Bool_t  mod2 
)
virtual

Truck the camera - 'move camera parallel to film plane'.

Returns kTRUE is redraw required (camera change), kFALSE otherwise.

Implements TGLCamera.

Definition at line 134 of file TGLPerspectiveCamera.cxx.

◆ Zoom()

Bool_t TGLPerspectiveCamera::Zoom ( Int_t  delta,
Bool_t  mod1,
Bool_t  mod2 
)
virtual

Zoom the camera - 'adjust lens focal length, retaining camera position'.

Arguments are:

Returns kTRUE is redraw required (camera change), kFALSE otherwise.

Implements TGLCamera.

Definition at line 118 of file TGLPerspectiveCamera.cxx.

Member Data Documentation

◆ fFOV

Double_t TGLPerspectiveCamera::fFOV
private

Definition at line 29 of file TGLPerspectiveCamera.h.

◆ fgFOVDefault

Double_t TGLPerspectiveCamera::fgFOVDefault = 30
staticprivate

Definition at line 31 of file TGLPerspectiveCamera.h.

◆ fgFOVDeltaSens

UInt_t TGLPerspectiveCamera::fgFOVDeltaSens = 500
staticprivate

Definition at line 32 of file TGLPerspectiveCamera.h.

◆ fgFOVMax

Double_t TGLPerspectiveCamera::fgFOVMax = 120.0
staticprivate

Definition at line 31 of file TGLPerspectiveCamera.h.

◆ fgFOVMin

Double_t TGLPerspectiveCamera::fgFOVMin = 0.01
staticprivate

Definition at line 31 of file TGLPerspectiveCamera.h.

Libraries for TGLPerspectiveCamera:
[legend]

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