csView Class Reference
The csView class encapsulates the top-level Crystal Space renderer interface. More...
#include <cstool/csview.h>
Public Member Functions | |
virtual void | AddViewVertex (int x, int y) |
Add a vertex to clipping polygon (non-rectangular clipping). | |
virtual void | ClearView () |
Clear clipper in order to start building a polygon-based clipper. | |
csView (iEngine *iEngine, iGraphics3D *ig3d) | |
Constructor. | |
virtual void | Draw (iMeshWrapper *mesh=0) |
Draw 3D world as seen from the camera. | |
virtual iCamera * | GetCamera () |
Get current camera. | |
virtual iClipper2D * | GetClipper () |
Return the clipper. | |
virtual iGraphics3D * | GetContext () |
Get Context. | |
virtual iCustomMatrixCamera * | GetCustomMatrixCamera () |
Get current custom matrix camera. | |
virtual iEngine * | GetEngine () |
Get engine handle. | |
virtual iPerspectiveCamera * | GetPerspectiveCamera () |
Get current perspective camera. | |
virtual csVector2 | NormalizedToScreen (const csVector2 &pos) |
Transform a normalized screenspace coordinate (-1 to 1) to real pixels in this viewport. | |
virtual void | RestrictClipperToScreen () |
Clip the view clipper to the screen boundaries. | |
virtual csVector2 | ScreenToNormalized (const csVector2 &pos) |
Transform a screenspace coordinate in pixels to a normalized screen coordinate (-1 to 1). | |
virtual void | SetAutoResize (bool state) |
Enable / Disable automatic resizing. | |
virtual void | SetCamera (iCamera *c) |
Set current camera. | |
virtual void | SetContext (iGraphics3D *ig3d) |
Set Context. | |
virtual void | SetCustomMatrixCamera (iCustomMatrixCamera *c) |
Set current perspective camera. | |
virtual void | SetEngine (iEngine *e) |
Set engine handle. | |
virtual void | SetPerspectiveCamera (iPerspectiveCamera *c) |
Set current perspective camera. | |
virtual void | SetRectangle (int x, int y, int w, int h, bool restrictToScreen=true) |
Set clipping rectangle. | |
virtual void | UpdateClipper () |
Update the Clipper. This is usually called from Draw. | |
virtual | ~csView () |
Destructor. |
Detailed Description
The csView class encapsulates the top-level Crystal Space renderer interface.
It is basically a camera and a clipper.
Definition at line 43 of file csview.h.
Constructor & Destructor Documentation
csView::csView | ( | iEngine * | iEngine, | |
iGraphics3D * | ig3d | |||
) |
Constructor.
virtual csView::~csView | ( | ) | [virtual] |
Destructor.
Member Function Documentation
virtual void csView::AddViewVertex | ( | int | x, | |
int | y | |||
) | [virtual] |
Add a vertex to clipping polygon (non-rectangular clipping).
Implements iView.
virtual void csView::ClearView | ( | ) | [virtual] |
Clear clipper in order to start building a polygon-based clipper.
Implements iView.
virtual void csView::Draw | ( | iMeshWrapper * | mesh = 0 |
) | [virtual] |
Draw 3D world as seen from the camera.
Implements iView.
virtual iClipper2D* csView::GetClipper | ( | ) | [virtual] |
Return the clipper.
Implements iView.
virtual iGraphics3D* csView::GetContext | ( | ) | [virtual] |
Get Context.
Implements iView.
virtual iCustomMatrixCamera* csView::GetCustomMatrixCamera | ( | ) | [virtual] |
Get current custom matrix camera.
Can return 0 if the current camera is not a custom matrix camera.
Implements iView.
virtual iPerspectiveCamera* csView::GetPerspectiveCamera | ( | ) | [virtual] |
Get current perspective camera.
Can return 0 if the current camera is not a perspective camera.
Implements iView.
virtual void csView::RestrictClipperToScreen | ( | ) | [virtual] |
Clip the view clipper to the screen boundaries.
Implements iView.
virtual void csView::SetAutoResize | ( | bool | state | ) | [inline, virtual] |
virtual void csView::SetContext | ( | iGraphics3D * | ig3d | ) | [virtual] |
Set Context.
Implements iView.
virtual void csView::SetCustomMatrixCamera | ( | iCustomMatrixCamera * | c | ) | [virtual] |
Set current perspective camera.
Implements iView.
virtual void csView::SetPerspectiveCamera | ( | iPerspectiveCamera * | c | ) | [virtual] |
Set current perspective camera.
Implements iView.
virtual void csView::SetRectangle | ( | int | x, | |
int | y, | |||
int | w, | |||
int | h, | |||
bool | restrictToScreen = true | |||
) | [virtual] |
Set clipping rectangle.
Implements iView.
virtual void csView::UpdateClipper | ( | ) | [virtual] |
Update the Clipper. This is usually called from Draw.
Implements iView.
The documentation for this class was generated from the following file:
- cstool/csview.h
Generated for Crystal Space 2.0 by doxygen 1.6.1