C4 Engine
C4 Engine API Documentation

class ViewportWidget

Defined in:  C4Viewports.h
The ViewportWidget class is the base class for interface widgets that display 3D viewports.
Definition

class ViewportWidget : public RenderableWidget

Member Functions
ViewportWidget::GetViewportCamera Returns the camera used by a viewport widget.
ViewportWidget::SetMouseEventCallback Sets the mouse event callback function for a viewport widget.
ViewportWidget::SetTrackTaskCallback Sets the track task callback function for a viewport widget.
ViewportWidget::SetDirectRenderCallback Sets the direct rendering callback function for a viewport widget.
ViewportWidget::SetTextureRenderCallback Sets the texture rendering callback function for a viewport widget.
ViewportWidget::EnableViewportTexture Allocates a texture map used to hold the image rendered in a viewport widget.
ViewportWidget::DisableViewportTexture Deallocates the texture map for a viewport widget.
ViewportWidget::InvalidateViewportTexture Invalidates the cached texture map for a viewport widget.
Constructor

ViewportWidget(ViewportType type, const Vector2D& size);

Parameters
type The type of the viewport.
size The size of the viewport, in pixels.
Description
The ViewportWidget class is the base class for interface widgets that display a viewport inside of which a 3D scene can be rendered. The type of camera used in the viewport, either an orthographic camera or a frustum camera, is determined by the subclass of ViewportWidget that is ultimately created.
Base Classes
RenderableWidget All rendered interface widgets are subclasses of RenderableWidget.
See Also

OrthoViewportWidget

FrustumViewportWidget