Public API Reference

                 

---

iView Struct Reference

The iView class encapsulates the top-level Crystal Space renderer interface. More...

#include <view.h>

Inheritance diagram for iView:

List of all members.

Public Methods
virtual iEngine *	GetEngine ()=0
	Get engine handle.
virtual void	SetEngine (iEngine *e)=0
	Set engine handle.
virtual iCamera *	GetCamera ()=0
	Get current camera.
virtual void	SetCamera (iCamera *c)=0
	Set current camera.
virtual iGraphics3D *	GetContext ()=0
	Get Context.
virtual void	SetContext (iGraphics3D *ig3d)=0
	Set Context.
virtual void	SetRectangle (int x, int y, int w, int h)=0
	Set clipping rectangle.
virtual void	ClearView ()=0
	Clear clipper in order to start building a polygon-based clipper.
virtual void	AddViewVertex (int x, int y)=0
	Add a vertex to clipping polygon (non-rectangular clipping).
virtual void	RestrictClipperToScreen ()=0
	Clip the view clipper to the screen boundaries.
virtual void	UpdateClipper ()=0
	Update the Clipper. This is usually called from Draw.
virtual iClipper2D *	GetClipper ()=0
	Return the current clipper. This function may call UpdateClipper ().
virtual void	Draw ()=0
	Draw 3D world as seen from the camera.

---

Detailed Description

The iView class encapsulates the top-level Crystal Space renderer interface.

It is basically a camera and a clipper.

Definition at line 36 of file view.h.

---

Member Function Documentation

virtual void iView::AddViewVertex (  int    x, int    y )  [pure virtual]

Add a vertex to clipping polygon (non-rectangular clipping). Implemented in csView.

virtual void iView::ClearView (    )  [pure virtual]

Clear clipper in order to start building a polygon-based clipper. Implemented in csView.

virtual void iView::Draw (    )  [pure virtual]

Draw 3D world as seen from the camera. Implemented in csView.

virtual iCamera* iView::GetCamera (    )  [pure virtual]

Get current camera. Implemented in csView.

virtual iClipper2D* iView::GetClipper (    )  [pure virtual]

Return the current clipper. This function may call UpdateClipper (). Implemented in csView.

virtual iGraphics3D* iView::GetContext (    )  [pure virtual]

Get Context. Implemented in csView.

virtual iEngine* iView::GetEngine (    )  [pure virtual]

Get engine handle. Implemented in csView.

virtual void iView::RestrictClipperToScreen (    )  [pure virtual]

Clip the view clipper to the screen boundaries. Implemented in csView.

virtual void iView::SetCamera (  iCamera *    c )  [pure virtual]

Set current camera. Implemented in csView.

virtual void iView::SetContext (  iGraphics3D *    ig3d )  [pure virtual]

Set Context. Implemented in csView.

virtual void iView::SetEngine (  iEngine *    e )  [pure virtual]

Set engine handle. Implemented in csView.

virtual void iView::SetRectangle (  int    x, int    y, int    w, int    h )  [pure virtual]

Set clipping rectangle. Implemented in csView.

virtual void iView::UpdateClipper (    )  [pure virtual]

Update the Clipper. This is usually called from Draw. Implemented in csView.

---

The documentation for this struct was generated from the following file:

• ivaria/view.h

---