Logo ROOT   6.19/01
Reference Guide
TGLParametricEquation Class Reference

A parametric surface is a surface defined by a parametric equation, involving two parameters (u, v):

S(u, v) = (x(u, v), y(u, v), z(u, v)).

For example, "limpet torus" surface can be defined as:

x = cos(u) / (sqrt(2) + sin(v))
y = sin(u) / (sqrt(2) + sin(v))
z = 1 / (sqrt(2) + cos(v)),

where -pi <= u <= pi, -pi <= v <= pi.

new TGLParametricEquation("Limpet_torus", "cos(u) / (sqrt(2.) + sin(v))",
"sin(u) / (sqrt(2.) + sin(v))",
"1 / (sqrt(2) + cos(v))");

$ROOTSYS/tutorials/gl/glparametric.C contains more examples.

Parametric equations can be specified:

  • 1. by string expressions, as with TF2, but with 'u' instead of 'x' and 'v' instead of 'y'.
  • 2. by function - see ParametricEquation_t declaration.

Definition at line 35 of file TGLParametric.h.

Public Member Functions

 TGLParametricEquation (const TString &name, const TString &xEquation, const TString &yEquation, const TString &zEquation, Double_t uMin, Double_t uMax, Double_t vMin, Double_t vMax)
 Surface is defined by three strings. More...
 
 TGLParametricEquation (const TString &name, ParametricEquation_t equation, Double_t uMin, Double_t uMax, Double_t vMin, Double_t vMax)
 Surface defined by user's function (see ParametricEquation_t declaration in TGLParametricEquation.h) More...
 
Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Check, if parametric surface is under cursor. More...
 
void EvalVertex (TGLVertex3 &newVertex, Double_t u, Double_t v) const
 Calculate vertex. More...
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Pass event to painter. More...
 
char * GetObjectInfo (Int_t px, Int_t py) const
 No object info yet. More...
 
Rgl::Range_t GetURange () const
 [uMin, uMax] More...
 
Rgl::Range_t GetVRange () const
 [vMin, vMax] More...
 
Bool_t IsConstrained () const
 Check is constrained. More...
 
Bool_t IsModified () const
 Something was changed in parametric equation (or constrained option was changed). More...
 
void Paint (Option_t *option)
 Delegate paint. More...
 
void SetConstrained (Bool_t c)
 Set constrained. More...
 
void SetModified (Bool_t m)
 Set modified. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. 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 Delete (Option_t *option="")
 Delete this 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 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 Option_tGetOption () const
 
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...
 
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
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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 Pop ()
 Pop on object drawn in a pad to the top of the display list. 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 Types

typedef std::unique_ptr< TGLHistPainterPainter_t
 
typedef std::unique_ptr< TF2Ptr_t
 

Private Member Functions

 TGLParametricEquation (const TGLParametricEquation &)
 
TGLParametricEquationoperator= (const TGLParametricEquation &)
 

Private Attributes

Bool_t fConstrained
 
ParametricEquation_t fEquation
 
Bool_t fModified
 
Painter_t fPainter
 
Rgl::Range_t fURange
 
Rgl::Range_t fVRange
 
Ptr_t fXEquation
 
Ptr_t fYEquation
 
Ptr_t fZEquation
 

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 ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TGLParametric.h>

Inheritance diagram for TGLParametricEquation:
[legend]

Member Typedef Documentation

◆ Painter_t

typedef std::unique_ptr<TGLHistPainter> TGLParametricEquation::Painter_t
private

Definition at line 51 of file TGLParametric.h.

◆ Ptr_t

typedef std::unique_ptr<TF2> TGLParametricEquation::Ptr_t
private

Definition at line 37 of file TGLParametric.h.

Constructor & Destructor Documentation

◆ TGLParametricEquation() [1/3]

TGLParametricEquation::TGLParametricEquation ( const TString name,
const TString xFun,
const TString yFun,
const TString zFun,
Double_t  uMin,
Double_t  uMax,
Double_t  vMin,
Double_t  vMax 
)

Surface is defined by three strings.

ROOT does not use exceptions in ctors, so, I have to use MakeZombie to let external user know about errors.

Definition at line 126 of file TGLParametric.cxx.

◆ TGLParametricEquation() [2/3]

TGLParametricEquation::TGLParametricEquation ( const TString name,
ParametricEquation_t  equation,
Double_t  uMin,
Double_t  uMax,
Double_t  vMin,
Double_t  vMax 
)

Surface defined by user's function (see ParametricEquation_t declaration in TGLParametricEquation.h)

Definition at line 174 of file TGLParametric.cxx.

◆ TGLParametricEquation() [3/3]

TGLParametricEquation::TGLParametricEquation ( const TGLParametricEquation )
private

Member Function Documentation

◆ DistancetoPrimitive()

Int_t TGLParametricEquation::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
virtual

Check, if parametric surface is under cursor.

Reimplemented from TObject.

Definition at line 256 of file TGLParametric.cxx.

◆ EvalVertex()

void TGLParametricEquation::EvalVertex ( TGLVertex3 newVertex,
Double_t  u,
Double_t  v 
) const

Calculate vertex.

Definition at line 240 of file TGLParametric.cxx.

◆ ExecuteEvent()

void TGLParametricEquation::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
virtual

Pass event to painter.

Reimplemented from TObject.

Definition at line 266 of file TGLParametric.cxx.

◆ GetObjectInfo()

char * TGLParametricEquation::GetObjectInfo ( Int_t  px,
Int_t  py 
) const
virtual

No object info yet.

Reimplemented from TObject.

Definition at line 275 of file TGLParametric.cxx.

◆ GetURange()

Rgl::Range_t TGLParametricEquation::GetURange ( ) const

[uMin, uMax]

Definition at line 192 of file TGLParametric.cxx.

◆ GetVRange()

Rgl::Range_t TGLParametricEquation::GetVRange ( ) const

[vMin, vMax]

Definition at line 200 of file TGLParametric.cxx.

◆ IsConstrained()

Bool_t TGLParametricEquation::IsConstrained ( ) const

Check is constrained.

Definition at line 208 of file TGLParametric.cxx.

◆ IsModified()

Bool_t TGLParametricEquation::IsModified ( ) const

Something was changed in parametric equation (or constrained option was changed).

Definition at line 224 of file TGLParametric.cxx.

◆ operator=()

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

◆ Paint()

void TGLParametricEquation::Paint ( Option_t option)
virtual

Delegate paint.

Reimplemented from TObject.

Definition at line 284 of file TGLParametric.cxx.

◆ SetConstrained()

void TGLParametricEquation::SetConstrained ( Bool_t  c)

Set constrained.

Definition at line 216 of file TGLParametric.cxx.

◆ SetModified()

void TGLParametricEquation::SetModified ( Bool_t  m)

Set modified.

Definition at line 232 of file TGLParametric.cxx.

Member Data Documentation

◆ fConstrained

Bool_t TGLParametricEquation::fConstrained
private

Definition at line 48 of file TGLParametric.h.

◆ fEquation

ParametricEquation_t TGLParametricEquation::fEquation
private

Definition at line 43 of file TGLParametric.h.

◆ fModified

Bool_t TGLParametricEquation::fModified
private

Definition at line 49 of file TGLParametric.h.

◆ fPainter

Painter_t TGLParametricEquation::fPainter
private

Definition at line 54 of file TGLParametric.h.

◆ fURange

Rgl::Range_t TGLParametricEquation::fURange
private

Definition at line 45 of file TGLParametric.h.

◆ fVRange

Rgl::Range_t TGLParametricEquation::fVRange
private

Definition at line 46 of file TGLParametric.h.

◆ fXEquation

Ptr_t TGLParametricEquation::fXEquation
private

Definition at line 39 of file TGLParametric.h.

◆ fYEquation

Ptr_t TGLParametricEquation::fYEquation
private

Definition at line 40 of file TGLParametric.h.

◆ fZEquation

Ptr_t TGLParametricEquation::fZEquation
private

Definition at line 41 of file TGLParametric.h.

Libraries for TGLParametricEquation:
[legend]

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