VSTGUI  4.4
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
COpenGLView Class Referenceabstract

a subview which uses OpenGL for drawing More...

+ Inheritance diagram for COpenGLView:

Public Member Functions

 COpenGLView (const CRect &size)
 
 ~COpenGLView ()
 
virtual void drawOpenGL (const CRect &updateRect)=0
 will be called when the view was marked invalid or the view was resized More...
 
virtual void reshape ()
 
virtual void setViewSize (const CRect &rect, bool invalid=true)
 set views size More...
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size More...
 
virtual bool removed (CView *parent)
 view is removed from parent view More...
 
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
CGraphicsTransform getGlobalTransform () const
 
template<typename T >
T & translateToGlobal (T &t) const
 
template<typename T >
translateToGlobal (const T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t) const
 translates a global coordinate to a local one using parent transforms More...
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 translates a local coordinate to a global one using parent transforms More...
 
void beforeDelete ()
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs More...
 
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled More...
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view More...
 
void setHitTestPath (CGraphicsPath *path)
 
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view More...
 
virtual bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area More...
 
virtual DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=0)
 start a drag operation. See CDropSource to create the source data package More...
 
virtual bool onDrop (IDataPackage *drag, const CPoint &where)
 called if a drag is dropped onto this view More...
 
virtual void onDragEnter (IDataPackage *drag, const CPoint &where)
 called if a drag is entering this view More...
 
virtual void onDragLeave (IDataPackage *drag, const CPoint &where)
 called if a drag is leaving this view More...
 
virtual void onDragMove (IDataPackage *drag, const CPoint &where)
 called if a drag is moved inside this view More...
 
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates More...
 
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates More...
 
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags More...
 
virtual int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual bool sizeToFit ()
 resize view to optimal size More...
 
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute More...
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view More...
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled More...
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled More...
 
CBitmapgetDrawBackground () const
 
virtual void setTransparency (bool val)
 set views transparent state More...
 
virtual bool getTransparency () const
 get views transparent state More...
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view More...
 
float getAlphaValue () const
 get alpha value More...
 
bool isAttached () const
 is view attached to a parentView More...
 
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual bool isDirty () const
 check if view is dirty More...
 
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More...
 
virtual void invalid ()
 mark whole view as invalid More...
 
bool isVisible () const
 get visibility state More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()
 
virtual ~CBaseObject ()
 
virtual void forget ()
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 

Protected Member Functions

COpenGLView Methods
virtual void platformOpenGLViewCreated ()
 will be called after the platform opengl view was created More...
 
virtual void platformOpenGLViewWillDestroy ()
 will be called before the platform opengl view will be destroyed More...
 
virtual void platformOpenGLViewSizeChanged ()
 will be called whenever the platform opengl view size has changed More...
 
virtual PixelFormat * getPixelFormat ()
 subclasses should return a pixelformat here if they don't want to use the default one More...
 
IPlatformOpenGLView * getPlatformOpenGLView () const
 
- Protected Member Functions inherited from CView
 ~CView ()
 
CGraphicsPathgetHitTestPath () const
 

Additional Inherited Members

- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false. More...
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 
- Protected Types inherited from CView
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kLastCViewFlag = 7
}
 
- Protected Attributes inherited from CView
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
int32_t viewFlags
 
int32_t autosizeFlags
 
float alphaValue
 

Detailed Description

a subview which uses OpenGL for drawing

Constructor & Destructor Documentation

COpenGLView ( const CRect size)

Member Function Documentation

bool attached ( CView parent)
virtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from CView.

virtual void drawOpenGL ( const CRect updateRect)
pure virtual

will be called when the view was marked invalid or the view was resized

virtual PixelFormat* getPixelFormat ( )
inlineprotectedvirtual

subclasses should return a pixelformat here if they don't want to use the default one

IPlatformOpenGLView* getPlatformOpenGLView ( ) const
inlineprotected
void invalidRect ( const CRect rect)
virtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from CView.

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual

Reimplemented from CView.

virtual CBaseObject* newCopy ( ) const
inlinevirtual

Reimplemented from CView.

void parentSizeChanged ( )
virtual

notification that one of the views parent has changed its size

Reimplemented from CView.

virtual void platformOpenGLViewCreated ( )
inlineprotectedvirtual

will be called after the platform opengl view was created

virtual void platformOpenGLViewSizeChanged ( )
inlineprotectedvirtual

will be called whenever the platform opengl view size has changed

virtual void platformOpenGLViewWillDestroy ( )
inlineprotectedvirtual

will be called before the platform opengl view will be destroyed

bool removed ( CView parent)
virtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

void reshape ( )
virtual
void setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
virtual

set views size

Parameters
newSizerect of new size of view
invalidif true set view dirty

Reimplemented from CView.

void setVisible ( bool  state)
virtual

set visibility state

Reimplemented from CView.


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