Abstract base camera class - concrete classes for orthographic and perspective cameras derive from it.

This class maintains values for the current:

Viewport
Projection, modelview and clip matrices - extracted from GL
The 6 frustum planes
Expanded frustum interest box

It provides methods for various projection, overlap and intersection tests for viewport and world locations, against the true frustum and expanded interest box, and for extracting eye position and direction.

It also defines the pure virtual manipulation interface methods the concrete ortho and perspective classes must implement.

Definition at line 43 of file TGLCamera.h.

Public Types
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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TGLCamera ()
	Default base camera constructor.

	TGLCamera (const TGLVector3 &hAxis, const TGLVector3 &vAxis)
	Default base camera constructor.

	~TGLCamera () override
	Base camera destructor.

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.

Double_t	AdjustDelta (Double_t screenShift, Double_t deltaFactor, Bool_t mod1, Bool_t mod2) const
	Adjust a passed screen value and apply modifiers.

virtual void	Apply (const TGLBoundingBox &sceneBox, const TGLRect *pickRect=nullptr) const =0

virtual void	Configure (Double_t zoom, Double_t dolly, Double_t center[3], Double_t hRotate, Double_t vRotate)=0

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'.

void	DrawDebugAids () const
	Draw out some debugging aids for the camera:

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.

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.

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.

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.

const TGLPlane &	FrustumPlane (EFrustumPlane plane) const

const TGLMatrix &	GetCamBase () const

const TGLMatrix &	GetCamTrans () const

Double_t *	GetCenterVec ()

Bool_t	GetExternalCenter ()

Double_t	GetFarClip () const

Double_t *	GetFixDefCenterVec ()

Double_t	GetNearClip () const

Double_t	GetTheta () const
	Get angle between camera up axis.

Float_t	GetVAxisMinAngle ()

void	IncTimeStamp ()

TClass *	IsA () const override

Bool_t	IsCacheDirty () const

virtual Bool_t	IsOrthographic () const

virtual Bool_t	IsPerspective () 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.

TGLMatrix &	RefCamBase ()

TGLMatrix &	RefCamTrans ()

TGLMatrix &	RefLastNoPickProjM () const

const TGLMatrix &	RefModelViewMatrix () const

TGLRect &	RefViewport ()

const TGLRect &	RefViewport () const

virtual void	Reset ()=0

void	ResetInterest ()
	Clear out the existing interest box.

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().

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().

virtual Bool_t	RotateArcBallRad (Double_t hRotate, Double_t vRotate)
	Rotate camera around center.

virtual Bool_t	RotateRad (Double_t hRotate, Double_t vRotate)
	Rotate camera around center.

void	SetCenterVec (Double_t x, Double_t y, Double_t z)
	Set camera center vector.

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.

void	SetExternalCenter (Bool_t x)
	Set camera center diffrent than scene center, if enable is kTRUE.

void	SetFixDefCenter (Bool_t x)

void	SetFixDefCenterVec (Double_t x, Double_t y, Double_t z)

virtual void	Setup (const TGLBoundingBox &box, Bool_t reset=kTRUE)=0

void	SetVAxisMinAngle (Float_t x)

void	SetViewport (const TGLRect &viewport)
	Set viewport extents from passed 'viewport' rect.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

UInt_t	TimeStamp () const

virtual Bool_t	Truck (Double_t xDelta, Double_t yDelta)
	Truck the camera - 'move camera parallel to film plane'.

virtual Bool_t	Truck (Int_t xDelta, Int_t yDelta, Bool_t mod1, Bool_t mod2)=0

Bool_t	UpdateInterest (Bool_t force)
	Update the internal interest box (fInterestBox) of the camera.

TGLVector3	ViewportDeltaToWorld (const TGLVertex3 &worldRef, Double_t viewportXDelta, Double_t viewportYDelta, TGLMatrix *modviewMat=nullptr) const
	Apply a 2D viewport delta (shift) to the projection of worldRef onto viewport, returning the resultant world vector which equates to it.

Rgl::EOverlap	ViewportOverlap (const TGLBoundingBox &box) const
	Calculate overlap (kInside, kOutside, kPartial) of box projection onto viewport (as rect) against the viewport rect.

std::pair< Bool_t, TGLVertex3 >	ViewportPlaneIntersection (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.

std::pair< Bool_t, TGLVertex3 >	ViewportPlaneIntersection (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.

TGLRect	ViewportRect (const TGLBoundingBox &box, const TGLBoundingBox::EFace *face=nullptr) const
	Calculate viewport rectangle which just contains projection of world frame bounding box 'box' onto the viewport.

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.

TGLVertex3	ViewportToWorld (const TGLVertex3 &viewportVertex, TGLMatrix *modviewMat=nullptr) const
	Convert a '3D' viewport vertex to 3D world one.

TGLLine3	ViewportToWorld (const TPoint &viewport) const
	Convert a 2D viewport position to 3D world line - the projection of the viewport point into 3D space.

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.

void	WindowToViewport (Int_t &, Int_t &y) const

void	WindowToViewport (TGLRect &rect) const

void	WindowToViewport (TGLVertex3 &vertex) const

void	WindowToViewport (TPoint &point) 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.

TGLVertex3	WorldToViewport (const TGLVertex3 &worldVertex, TGLMatrix *modviewMat=nullptr) const
	Convert a 3D world vertex to '3D' viewport (screen) one.

virtual Bool_t	Zoom (Int_t delta, Bool_t mod1, Bool_t mod2)=0

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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.

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

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.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Member Functions
void	UpdateCache () const
	largest box diagonal seen in OfInterest() - used when bootstrapping interest box

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).

void	MakeZombie ()

Protected Attributes
Bool_t	fCacheDirty

TGLMatrix	fCamBase

TGLMatrix	fCamTrans

TGLVector3 *	fCenter

TGLMatrix	fClipM
	modelView matrix (cached)

TGLVector3	fDefCenter

Double_t	fDollyDefault
	last applied far-clip

Double_t	fDollyDistance

TGLVector3	fExtCenter

Bool_t	fExternalCenter

Double_t	fFarClip
	last applied near-clip

TGLVector3	fFDCenter

Bool_t	fFixDefCenter

TGLPlane	fFrustumPlanes [kPlanesPerFrustum]
	object space clip matrix (cached)

TGLBoundingBox	fInterestBox
	viewport (GL coords - origin bottom left)

Double_t	fLargestSeen
	the interest box - created in UpdateInterest()

TGLMatrix	fLastNoPickProjM
	timestamp

TGLMatrix	fModVM
	projection matrix (cached)

Double_t	fNearClip
	current camera center

TGLMatrix	fProjM
	no-pick projection matrix (cached)

UInt_t	fTimeStamp
	cached items dirty?

Float_t	fVAxisMinAngle

TGLRect	fViewport
	frustum planes (cached)

Bool_t	fWasArcBalled

Static Protected Attributes
static UInt_t	fgDollyDeltaSens = 500

Private Member Functions
	TGLCamera (const TGLCamera &)

TGLBoundingBox	Frustum (Bool_t asBox=kTRUE) const
	expansion c.f. aligned current frustum box

TGLCamera &	operator= (const TGLCamera &)

Private Attributes
TGLBoundingBox	fInterestFrustum
	previous interest box (DEBUG)

TGLBoundingBox	fInterestFrustumAsBox
	frustum basis of current interest box - NOT a true BB! (DEBUG)

TGLBoundingBox	fPreviousInterestBox

Static Private Attributes
static const Double_t	fgInterestBoxExpansion = 1.3
	frustum basis (as box) of current interest box (DEBUG)

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TGLCamera.h>

Inheritance diagram for TGLCamera:

[legend]

Member Enumeration Documentation

◆ EFrustumPlane

enum TGLCamera::EFrustumPlane

Enumerator
kNear
kLeft
kRight
kTop
kBottom
kFar
kPlanesPerFrustum

Definition at line 46 of file TGLCamera.h.

Constructor & Destructor Documentation

◆ TGLCamera() [1/3]

TGLCamera::TGLCamera ( const TGLCamera & )

private

◆ TGLCamera() [2/3]

TGLCamera::TGLCamera ( )

Default base camera constructor.

Definition at line 44 of file TGLCamera.cxx.

◆ TGLCamera() [3/3]

TGLCamera::TGLCamera	(	const TGLVector3 &	hAxis,
		const TGLVector3 &	vAxis
	)

Default base camera constructor.

Definition at line 68 of file TGLCamera.cxx.

◆ ~TGLCamera()

TGLCamera::~TGLCamera ( )

override

Base camera destructor.

Definition at line 92 of file TGLCamera.cxx.

Member Function Documentation

◆ AdjustAndClampVal()

Bool_t TGLCamera::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.

Two modifier flags ('mod1' / 'mod2' ) for sensitivity:

mod1 = kFALSE, mod2 = kFALSE : normal sensitivity (screenShift/screenShiftRange)
mod1 = kTRUE, mod2 = kFALSE : 0.1x sensitivity
mod1 = kTRUE, mod2 = kTRUE : 0.01x sensitivity
mod1 = kFALSE, mod2 = kTRUE : 10.0x sensitivity

'val' is modified and clamped to 'min' / 'max' range. Return bool kTRUE if val actually changed.

Used as common interaction function for adjusting zoom/dolly etc

Definition at line 722 of file TGLCamera.cxx.

◆ AdjustDelta()

Double_t TGLCamera::AdjustDelta	(	Double_t	screenShift,
		Double_t	deltaFactor,
		Bool_t	mod1,
		Bool_t	mod2
	)		const

Adjust a passed screen value and apply modifiers.

See AdjustAndClampVal() for details.

Definition at line 762 of file TGLCamera.cxx.

◆ Apply()

virtual void TGLCamera::Apply	(	const TGLBoundingBox &	sceneBox,
		const TGLRect *	pickRect = `nullptr`
	)		const

pure virtual

Implemented in TGLPerspectiveCamera, and TGLOrthoCamera.

◆ Class()

static TClass * TGLCamera::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TGLCamera::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TGLCamera::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 216 of file TGLCamera.h.

◆ Configure()

virtual void TGLCamera::Configure	(	Double_t	zoom,
		Double_t	dolly,
		Double_t	center[3],
		Double_t	hRotate,
		Double_t	vRotate
	)

pure virtual

Implemented in TGLPerspectiveCamera, and TGLOrthoCamera.

◆ DeclFileName()

static const char * TGLCamera::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 216 of file TGLCamera.h.

◆ Dolly()

Bool_t TGLCamera::Dolly	(	Int_t	delta,
		Bool_t	mod1,
		Bool_t	mod2
	)

virtual

Dolly the camera - 'move camera along eye line, retaining lens focal length'.

Arguments are:

'delta' - mouse viewport delta (pixels) - +ive dolly in, -ive dolly out
'mod1' / 'mod2' - sensitivity modifiers - see TGLCamera::AdjustAndClampVal()

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

Reimplemented in TGLOrthoCamera.

Definition at line 1046 of file TGLCamera.cxx.

◆ DrawDebugAids()

void TGLCamera::DrawDebugAids ( ) const

Draw out some debugging aids for the camera:

The frustum used to create the current interest box (RED)
The same frustum as a squared off box (ORANGE)
The axis aligned version of the frustum used as interest box basis (YELLOW)
The current interest box (BLUE)

Definition at line 793 of file TGLCamera.cxx.

◆ EyeDirection()

TGLVector3 TGLCamera::EyeDirection ( ) const

Extract the camera eye direction (vector), running from EyePoint() Camera must have valid frustum cache - call Apply() after last modification, before using.

Definition at line 236 of file TGLCamera.cxx.

◆ EyePoint()

TGLVertex3 TGLCamera::EyePoint ( ) const

Return the camera eye point (vertex) in world space Camera must have valid frustum cache - call Apply() after last modification, before using.

Definition at line 219 of file TGLCamera.cxx.

◆ Frustum()

TGLBoundingBox TGLCamera::Frustum ( Bool_t asBox = kTRUE ) const

private

expansion c.f. aligned current frustum box

Return the current camera frustum.

If asBox == kFALSE return a true frustum (truncated square based pyramid). If asBox == kTRUE return a true box, using the far clipping plane intersection projected back to the near plane.

Camera must have valid frustum cache - call Apply() after last modification, before using

Note: TGLBoundingBox is not really valid when filled with truncated pyramid

this is used as a visual debug aid only so ok.

Definition at line 171 of file TGLCamera.cxx.

◆ FrustumCenter()

TGLVertex3 TGLCamera::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.

Definition at line 251 of file TGLCamera.cxx.

◆ FrustumOverlap()

Rgl::EOverlap TGLCamera::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.

Definition at line 275 of file TGLCamera.cxx.

◆ FrustumPlane()

const TGLPlane & TGLCamera::FrustumPlane ( EFrustumPlane plane ) const

inline

Definition at line 219 of file TGLCamera.h.

◆ GetCamBase()

const TGLMatrix & TGLCamera::GetCamBase ( ) const

inline

Definition at line 166 of file TGLCamera.h.

◆ GetCamTrans()

const TGLMatrix & TGLCamera::GetCamTrans ( ) const

inline

Definition at line 167 of file TGLCamera.h.

◆ GetCenterVec()

Double_t * TGLCamera::GetCenterVec ( )

inline

Definition at line 157 of file TGLCamera.h.

◆ GetExternalCenter()

Bool_t TGLCamera::GetExternalCenter ( )

inline

Definition at line 153 of file TGLCamera.h.

◆ GetFarClip()

Double_t TGLCamera::GetFarClip ( ) const

inline

Definition at line 164 of file TGLCamera.h.

◆ GetFixDefCenterVec()

Double_t * TGLCamera::GetFixDefCenterVec ( )

inline

Definition at line 161 of file TGLCamera.h.

◆ GetNearClip()

Double_t TGLCamera::GetNearClip ( ) const

inline

Definition at line 163 of file TGLCamera.h.

◆ GetTheta()

Double_t TGLCamera::GetTheta ( ) const

Get angle between camera up axis.

Definition at line 882 of file TGLCamera.cxx.

◆ GetVAxisMinAngle()

Float_t TGLCamera::GetVAxisMinAngle ( )

inline

Definition at line 203 of file TGLCamera.h.

◆ IncTimeStamp()

void TGLCamera::IncTimeStamp ( )

inline

Definition at line 124 of file TGLCamera.h.

◆ IsA()

TClass * TGLCamera::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TGLOrthoCamera, and TGLPerspectiveCamera.

Definition at line 216 of file TGLCamera.h.

◆ IsCacheDirty()

Bool_t TGLCamera::IsCacheDirty ( ) const

inline

Definition at line 123 of file TGLCamera.h.

◆ IsOrthographic()

virtual Bool_t TGLCamera::IsOrthographic ( ) const

inlinevirtual

Reimplemented in TGLOrthoCamera.

Definition at line 118 of file TGLCamera.h.

◆ IsPerspective()

virtual Bool_t TGLCamera::IsPerspective ( ) const

inlinevirtual

Reimplemented in TGLPerspectiveCamera.

Definition at line 119 of file TGLCamera.h.

◆ OfInterest()

Bool_t TGLCamera::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.

This is defined as box:

intersecting completely or partially (kInside/kPartial) with cameras interest box (fInterestBox)
having significant length OR volume ratio compared to this interest box

If a box is 'of interest' returns kTRUE, kFALSE otherwise. See TGLCamera::UpdateInterest() for more details of camera interest box.

Note: Length/volume ratios NOT dependent on the projected size of box at current camera configuration as we do not want continual changes. This is used when (re) populating the scene with objects from external client.

TODO: Might be more logical to move this test out to client - and have accessor for fInterestBox instead?

Definition at line 578 of file TGLCamera.cxx.

◆ operator=()

TGLCamera & TGLCamera::operator= ( const TGLCamera & )

private

◆ RefCamBase()

TGLMatrix & TGLCamera::RefCamBase ( )

inline

Definition at line 169 of file TGLCamera.h.

◆ RefCamTrans()

TGLMatrix & TGLCamera::RefCamTrans ( )

inline

Definition at line 170 of file TGLCamera.h.

◆ RefLastNoPickProjM()

TGLMatrix & TGLCamera::RefLastNoPickProjM ( ) const

inline

Definition at line 174 of file TGLCamera.h.

◆ RefModelViewMatrix()

const TGLMatrix & TGLCamera::RefModelViewMatrix ( ) const

inline

Definition at line 121 of file TGLCamera.h.

◆ RefViewport() [1/2]

TGLRect & TGLCamera::RefViewport ( )

inline

Definition at line 128 of file TGLCamera.h.

◆ RefViewport() [2/2]

const TGLRect & TGLCamera::RefViewport ( ) const

inline

Definition at line 129 of file TGLCamera.h.

◆ Reset()

virtual void TGLCamera::Reset ( )

pure virtual

Implemented in TGLOrthoCamera, and TGLPerspectiveCamera.

◆ ResetInterest()

void TGLCamera::ResetInterest ( )

Clear out the existing interest box.

Definition at line 699 of file TGLCamera.cxx.

◆ Rotate()

Bool_t TGLCamera::Rotate	(	Int_t	xDelta,
		Int_t	yDelta,
		Bool_t	mod1,
		Bool_t	mod2
	)

virtual

Rotate the camera round view volume center established in Setup().

Arguments are:

xDelta - horizontal delta (pixels)
YDelta - vertical delta (pixels)

Reimplemented in TGLOrthoCamera.

Definition at line 916 of file TGLCamera.cxx.

◆ RotateArcBall()

Bool_t TGLCamera::RotateArcBall	(	Int_t	xDelta,
		Int_t	yDelta,
		Bool_t	mod1,
		Bool_t	mod2
	)

virtual

Rotate the camera round view volume center established in Setup().

Arguments are:

xDelta - horizontal delta (pixels)
YDelta - vertical delta (pixels)

Definition at line 990 of file TGLCamera.cxx.

◆ RotateArcBallRad()

Bool_t TGLCamera::RotateArcBallRad	(	Double_t	hRotate,
		Double_t	vRotate
	)

virtual

Rotate camera around center.

Definition at line 1001 of file TGLCamera.cxx.

◆ RotateRad()

Bool_t TGLCamera::RotateRad	(	Double_t	hRotate,
		Double_t	vRotate
	)

virtual

Rotate camera around center.

Definition at line 927 of file TGLCamera.cxx.

◆ SetCenterVec()

void TGLCamera::SetCenterVec	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

Set camera center vector.

Definition at line 847 of file TGLCamera.cxx.

◆ SetCenterVecWarp()

void TGLCamera::SetCenterVecWarp	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

Set camera center vector and do not keep the same combined camera transformation matrix.

It appears as if the camera warped to the new center.

Definition at line 867 of file TGLCamera.cxx.

◆ SetExternalCenter()

void TGLCamera::SetExternalCenter ( Bool_t x )

Set camera center diffrent than scene center, if enable is kTRUE.

Definition at line 825 of file TGLCamera.cxx.

◆ SetFixDefCenter()

void TGLCamera::SetFixDefCenter ( Bool_t x )

inline

Definition at line 159 of file TGLCamera.h.

◆ SetFixDefCenterVec()

void TGLCamera::SetFixDefCenterVec	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

inline

Definition at line 160 of file TGLCamera.h.

◆ Setup()

virtual void TGLCamera::Setup	(	const TGLBoundingBox &	box,
		Bool_t	reset = `kTRUE`
	)

pure virtual

Implemented in TGLOrthoCamera, and TGLPerspectiveCamera.

◆ SetVAxisMinAngle()

void TGLCamera::SetVAxisMinAngle ( Float_t x )

inline

Definition at line 204 of file TGLCamera.h.

◆ SetViewport()

void TGLCamera::SetViewport ( const TGLRect & viewport )

Set viewport extents from passed 'viewport' rect.

Definition at line 99 of file TGLCamera.cxx.

◆ Streamer()

void TGLCamera::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TGLOrthoCamera, and TGLPerspectiveCamera.

◆ StreamerNVirtual()

void TGLCamera::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 216 of file TGLCamera.h.

◆ TimeStamp()

UInt_t TGLCamera::TimeStamp ( ) const

inline

Definition at line 125 of file TGLCamera.h.

◆ Truck() [1/2]

Bool_t TGLCamera::Truck	(	Double_t	xDelta,
		Double_t	yDelta
	)

virtual

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

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

Reimplemented in TGLOrthoCamera, and TGLPerspectiveCamera.

Definition at line 894 of file TGLCamera.cxx.

◆ Truck() [2/2]

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

pure virtual

Implemented in TGLOrthoCamera, TGLPerspectiveCamera, TGLOrthoCamera, and TGLPerspectiveCamera.

◆ UpdateCache()

void TGLCamera::UpdateCache ( ) const

protected

largest box diagonal seen in OfInterest() - used when bootstrapping interest box

Update internally cached frustum values.

Definition at line 108 of file TGLCamera.cxx.

◆ UpdateInterest()

Bool_t TGLCamera::UpdateInterest ( Bool_t force )

Update the internal interest box (fInterestBox) of the camera.

The interest box is an orientated bounding box, calculated as an expanded container round the frustum. It is used to test if if object bounding boxes are of interest (should be accepted into viewer scene) for a camera - see TGLCamera::OfInterest()

The interest box is updated if the frustum is no longer contained in the existing one, or a new one calculated on the current frustum differs significantly in volume (camera has been zoomed/dollyed sizable amount).

If the interest box is updated we return kTRUE - kFALSE otherwise.

Definition at line 643 of file TGLCamera.cxx.

◆ ViewportDeltaToWorld()

TGLVector3 TGLCamera::ViewportDeltaToWorld	(	const TGLVertex3 &	worldRef,
		Double_t	viewportXDelta,
		Double_t	viewportYDelta,
		TGLMatrix *	modviewMat = `nullptr`
	)		const

Apply a 2D viewport delta (shift) to the projection of worldRef onto viewport, returning the resultant world vector which equates to it.

Useful for making 3D world objects track mouse moves.

Camera must have valid frustum cache - call Apply()

Definition at line 546 of file TGLCamera.cxx.

◆ ViewportOverlap()

Rgl::EOverlap TGLCamera::ViewportOverlap ( const TGLBoundingBox & box ) const

Calculate overlap (kInside, kOutside, kPartial) of box projection onto viewport (as rect) against the viewport rect.

Camera must have valid frustum cache - call Apply() after last modification, before using.

Definition at line 319 of file TGLCamera.cxx.

◆ ViewportPlaneIntersection() [1/2]

std::pair< Bool_t, TGLVertex3 > TGLCamera::ViewportPlaneIntersection	(	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.

Returns std::pair of bool and vertex. If line intersects

Camera must have valid frustum cache - call Apply() after last modification, before using

Definition at line 533 of file TGLCamera.cxx.

◆ ViewportPlaneIntersection() [2/2]

std::pair< Bool_t, TGLVertex3 > TGLCamera::ViewportPlaneIntersection	(	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.

Returns std::pair of Bool_t and TGLVertex3. If line intersects std::pair.first (Bool_t) is kTRUE, and std::pair.second (TGLVertex) contains the intersection vertex. If line does not intersect (line and plane parallel) std::pair.first (Bool_t) if kFALSE, and std::pair.second (TGLVertex) is invalid.

NOTE: The projection lines is extended for the plane intersection test hence the intersection vertex can lie outside the near/far clip regions (not visible)

Camera must have valid frustum cache - call Apply() after last modification, before using

Definition at line 517 of file TGLCamera.cxx.

◆ ViewportRect() [1/2]

TGLRect TGLCamera::ViewportRect	(	const TGLBoundingBox &	box,
		const TGLBoundingBox::EFace *	face = `nullptr`
	)		const

Calculate viewport rectangle which just contains projection of world frame bounding box 'box' onto the viewport.

If face is null the rect contains the whole bounding box (8 vertices/6 faces). If face is non-null it indicates a box face, and the rect contains the single face (4 vertices). Note use other version of ViewportRect() if you wish to just pass a static EFace enum member (e.g. kFaceLowX)

Note:

Rectangle is NOT clipped by viewport limits - so can result in rect with corners outside viewport - negative etc
TGLRect provides int (pixel based) values - not subpixel accurate
Camera must have valid frustum cache - call Apply() after last modification, before calling

Definition at line 351 of file TGLCamera.cxx.

◆ ViewportRect() [2/2]

TGLRect TGLCamera::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.

Note use other version of ViewportRect() if you want whole 'box' contained

Definition at line 329 of file TGLCamera.cxx.

◆ ViewportToWorld() [1/3]

TGLVertex3 TGLCamera::ViewportToWorld	(	const TGLVertex3 &	viewportVertex,
		TGLMatrix *	modviewMat = `nullptr`
	)		const

Convert a '3D' viewport vertex to 3D world one.

The X()/Y() components of viewportVertex are the horizontal/vertical pixel position.

Definition at line 442 of file TGLCamera.cxx.

◆ ViewportToWorld() [2/3]

TGLLine3 TGLCamera::ViewportToWorld ( const TPoint & viewport ) const

Convert a 2D viewport position to 3D world line - the projection of the viewport point into 3D space.

Line runs from near to far camera clip planes (the minimum and maximum visible depth). See also TGLVertex3 TGLCamera::ViewportToWorld(const TGLVertex3 & viewportVertex) const for 3D viewport -> 3D world vertex conversions. See also OpenGL gluUnProject & glDepth documentation

Camera must have valid frustum cache - call Apply() after last modification, before using

Definition at line 498 of file TGLCamera.cxx.

◆ ViewportToWorld() [3/3]

TGLLine3 TGLCamera::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.

Line runs from near to far camera clip planes (the minimum and maximum visible depth). See also TGLVertex3 TGLCamera::ViewportToWorld(const TGLVertex3 & viewportVertex) const for 3D viewport -> 3D world vertex conversions. See also OpenGL gluUnProject & glDepth documentation

Camera must have valid frustum cache - call Apply() after last modification, before using

Definition at line 477 of file TGLCamera.cxx.

◆ WindowToViewport() [1/4]

void TGLCamera::WindowToViewport	(	Int_t &	,
		Int_t &	y
	)		const

inline

Definition at line 198 of file TGLCamera.h.

◆ WindowToViewport() [2/4]

void TGLCamera::WindowToViewport ( TGLRect & rect ) const

inline

Definition at line 200 of file TGLCamera.h.

◆ WindowToViewport() [3/4]

void TGLCamera::WindowToViewport ( TGLVertex3 & vertex ) const

inline

Definition at line 201 of file TGLCamera.h.

◆ WindowToViewport() [4/4]

void TGLCamera::WindowToViewport ( TPoint & point ) const

inline

Definition at line 199 of file TGLCamera.h.

◆ WorldDeltaToViewport()

TGLVector3 TGLCamera::WorldDeltaToViewport	(	const TGLVertex3 &	worldRef,
		const TGLVector3 &	worldDelta
	)		const

Convert a 3D vector worldDelta (shift) about vertex worldRef to a viewport (screen) '3D' vector.

The X()/Y() components of the vector are the horizontal / vertical pixel deltas. The Z() component is the viewport depth delta - for a default depth range between 0.0 (at near clip plane) to 1.0 (at far clip plane) See OpenGL gluProject & glDepth documentation

Camera must have valid frustum cache - call Apply()

Definition at line 426 of file TGLCamera.cxx.

◆ WorldToViewport()

TGLVertex3 TGLCamera::WorldToViewport	(	const TGLVertex3 &	worldVertex,
		TGLMatrix *	modviewMat = `nullptr`
	)		const

Convert a 3D world vertex to '3D' viewport (screen) one.

The X()/Y() components of the viewport vertex are the horizontal/vertical pixel positions. The Z() component is the viewport depth value - for a default depth range this is 0.0 (at near clip plane) to 1.0 (at far clip plane). See OpenGL gluProject & glDepth documentation

Camera must have valid frustum cache - call Apply() after last modification, before using

Definition at line 403 of file TGLCamera.cxx.

◆ Zoom()

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

pure virtual

Implemented in TGLOrthoCamera, and TGLPerspectiveCamera.

Member Data Documentation

◆ fCacheDirty

Bool_t TGLCamera::fCacheDirty

mutableprotected

Definition at line 95 of file TGLCamera.h.

◆ fCamBase

TGLMatrix TGLCamera::fCamBase

protected

Definition at line 76 of file TGLCamera.h.

◆ fCamTrans

TGLMatrix TGLCamera::fCamTrans

protected

Definition at line 77 of file TGLCamera.h.

◆ fCenter

TGLVector3* TGLCamera::fCenter

protected

Definition at line 84 of file TGLCamera.h.

◆ fClipM

TGLMatrix TGLCamera::fClipM

mutableprotected

modelView matrix (cached)

Definition at line 100 of file TGLCamera.h.

◆ fDefCenter

TGLVector3 TGLCamera::fDefCenter

protected

Definition at line 82 of file TGLCamera.h.

◆ fDollyDefault

Double_t TGLCamera::fDollyDefault

protected

last applied far-clip

Definition at line 90 of file TGLCamera.h.

◆ fDollyDistance

Double_t TGLCamera::fDollyDistance

protected

Definition at line 91 of file TGLCamera.h.

◆ fExtCenter

TGLVector3 TGLCamera::fExtCenter

protected

Definition at line 81 of file TGLCamera.h.

◆ fExternalCenter

Bool_t TGLCamera::fExternalCenter

protected

Definition at line 78 of file TGLCamera.h.

◆ fFarClip

Double_t TGLCamera::fFarClip

mutableprotected

last applied near-clip

Definition at line 87 of file TGLCamera.h.

◆ fFDCenter

TGLVector3 TGLCamera::fFDCenter

protected

Definition at line 83 of file TGLCamera.h.

◆ fFixDefCenter

Bool_t TGLCamera::fFixDefCenter

protected

Definition at line 79 of file TGLCamera.h.

◆ fFrustumPlanes

TGLPlane TGLCamera::fFrustumPlanes[kPlanesPerFrustum]

mutableprotected

object space clip matrix (cached)

Definition at line 101 of file TGLCamera.h.

◆ fgDollyDeltaSens

UInt_t TGLCamera::fgDollyDeltaSens = 500

staticprotected

Definition at line 112 of file TGLCamera.h.

◆ fgInterestBoxExpansion

const Double_t TGLCamera::fgInterestBoxExpansion = 1.3

staticprivate

frustum basis (as box) of current interest box (DEBUG)

Definition at line 65 of file TGLCamera.h.

◆ fInterestBox

TGLBoundingBox TGLCamera::fInterestBox

protected

viewport (GL coords - origin bottom left)

Definition at line 105 of file TGLCamera.h.

◆ fInterestFrustum

TGLBoundingBox TGLCamera::fInterestFrustum

private

previous interest box (DEBUG)

Definition at line 62 of file TGLCamera.h.

◆ fInterestFrustumAsBox

TGLBoundingBox TGLCamera::fInterestFrustumAsBox

private

frustum basis of current interest box - NOT a true BB! (DEBUG)

Definition at line 63 of file TGLCamera.h.

◆ fLargestSeen

Double_t TGLCamera::fLargestSeen

mutableprotected

the interest box - created in UpdateInterest()

Definition at line 106 of file TGLCamera.h.

◆ fLastNoPickProjM

TGLMatrix TGLCamera::fLastNoPickProjM

mutableprotected

timestamp

Definition at line 97 of file TGLCamera.h.

◆ fModVM

TGLMatrix TGLCamera::fModVM

mutableprotected

projection matrix (cached)

Definition at line 99 of file TGLCamera.h.

◆ fNearClip

Double_t TGLCamera::fNearClip

mutableprotected

current camera center

Definition at line 86 of file TGLCamera.h.

◆ fPreviousInterestBox

TGLBoundingBox TGLCamera::fPreviousInterestBox

private

Definition at line 61 of file TGLCamera.h.

◆ fProjM

TGLMatrix TGLCamera::fProjM

mutableprotected

no-pick projection matrix (cached)

Definition at line 98 of file TGLCamera.h.

◆ fTimeStamp

UInt_t TGLCamera::fTimeStamp

mutableprotected

cached items dirty?

Definition at line 96 of file TGLCamera.h.

◆ fVAxisMinAngle

Float_t TGLCamera::fVAxisMinAngle

protected

Definition at line 92 of file TGLCamera.h.

◆ fViewport

TGLRect TGLCamera::fViewport

protected

frustum planes (cached)

Definition at line 103 of file TGLCamera.h.

◆ fWasArcBalled

Bool_t TGLCamera::fWasArcBalled

protected

Definition at line 80 of file TGLCamera.h.

Libraries for TGLCamera:

[legend]

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

graf3d/gl/inc/TGLCamera.h
graf3d/gl/src/TGLCamera.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EFrustumPlane

Constructor & Destructor Documentation

◆ TGLCamera() [1/3]

◆ TGLCamera() [2/3]

◆ TGLCamera() [3/3]

◆ ~TGLCamera()

Member Function Documentation

◆ AdjustAndClampVal()

◆ AdjustDelta()

◆ Apply()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Configure()

◆ DeclFileName()

◆ Dolly()

◆ DrawDebugAids()

◆ EyeDirection()

◆ EyePoint()

◆ Frustum()

◆ FrustumCenter()

◆ FrustumOverlap()

◆ FrustumPlane()

◆ GetCamBase()

◆ GetCamTrans()

◆ GetCenterVec()

◆ GetExternalCenter()

◆ GetFarClip()

◆ GetFixDefCenterVec()

◆ GetNearClip()

◆ GetTheta()

◆ GetVAxisMinAngle()

◆ IncTimeStamp()

◆ IsA()

◆ IsCacheDirty()

◆ IsOrthographic()

◆ IsPerspective()

◆ OfInterest()

◆ operator=()

◆ RefCamBase()

◆ RefCamTrans()

◆ RefLastNoPickProjM()

◆ RefModelViewMatrix()

◆ RefViewport() [1/2]

◆ RefViewport() [2/2]

◆ Reset()

◆ ResetInterest()

◆ Rotate()

◆ RotateArcBall()

◆ RotateArcBallRad()

◆ RotateRad()

◆ SetCenterVec()

◆ SetCenterVecWarp()

◆ SetExternalCenter()

◆ SetFixDefCenter()

◆ SetFixDefCenterVec()

◆ Setup()

◆ SetVAxisMinAngle()

◆ SetViewport()

◆ Streamer()

◆ StreamerNVirtual()

◆ TimeStamp()

◆ Truck() [1/2]

◆ Truck() [2/2]

◆ UpdateCache()

◆ UpdateInterest()

◆ ViewportDeltaToWorld()

◆ ViewportOverlap()

◆ ViewportPlaneIntersection() [1/2]