ISceneGraphEvents.BeforeDraw Event

Fired when drawing starts.

[Visual Basic .NET]
Public Event BeforeDraw As BeforeDrawEventHandler

[C#]
public event BeforeDrawEventHandler BeforeDraw

[C++]
HRESULT BeforeDraw(
  ISceneViewer* pViewer,
  VARIANT_BOOL* pbHandled
);

[C++]

Parameters
pViewer [in]

  pViewer is a parameter of type ISceneViewer
pbHandled [out, retval]
  pbHandled is a parameter of type VARIANT_BOOL

Product Availability

Remarks

This event method is often used by an OpenGL routine that renders something before the main features in the scene are drawn.  A good example is the scene background, such as sky/sun/moon etc.  Just like the art of painting, one normally needs to draw the background first and then the main feature.  So this method is generally for the background rendering.  It can also be used for executing some routines other than drawing.

The BeforeDraw method returns a boolean value.  When it's set to true, the SceneGraph's drawing is disabled, and you as a developer take control of the drawing (e.g. via OpenGL).  Otherwise, the SceneGraph takes care of drawing as usual.

See Also