crystalspace.jbind.interfaces.ivaria.view
Interface iView

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csView, csView

public interface iView

extends iBase

The iView class encapsulates the native Crystal Space renderer interface. It is basically a camera and a clipper.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiView.php

Method Summary

void	addViewVertex(int x, int y) Add a vertex to clipping polygon (non-rectangular clipping).
void	clearView() Clear clipper in order to start building a polygon-based clipper.
void	draw() Draw 3D world as seen from the camera.
iCamera	getCamera() Get current camera.
iClipper2D	getClipper() Return the current clipper.
iGraphics3D	getContext() Get Context.
iEngine	getEngine() Get engine handle.
void	restrictClipperToScreen() Clip the view clipper to the screen boundaries.
void	setCamera(iCamera c) Set current camera.
void	setContext(iGraphics3D ig3d) Set Context.
void	setEngine(iEngine e) Set engine handle.
void	setRectangle(int x, int y, int w, int h) Set clipping rectangle.
void	updateClipper() Update the Clipper.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

getEngine

public iEngine getEngine()

Get engine handle.

Returns:

iEngine

setEngine

public void setEngine(iEngine e)

Set engine handle.

Parameters:

e -

getCamera

public iCamera getCamera()

Get current camera.

Returns:

iCamera

setCamera

public void setCamera(iCamera c)

Set current camera.

Parameters:

c -

getContext

public iGraphics3D getContext()

Get Context.

Returns:

iGraphics3D

setContext

public void setContext(iGraphics3D ig3d)

Set Context.

Parameters:

ig3d -

setRectangle

public void setRectangle(int x,
                         int y,
                         int w,
                         int h)

Set clipping rectangle.

Parameters:

x -

y -

w -

h -

clearView

public void clearView()

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

addViewVertex

public void addViewVertex(int x,
                          int y)

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

Parameters:

x -

y -

restrictClipperToScreen

public void restrictClipperToScreen()

Clip the view clipper to the screen boundaries.

updateClipper

public void updateClipper()

Update the Clipper. This is usually called from Draw.

getClipper

public iClipper2D getClipper()

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

Returns:

iClipper2D

draw

public void draw()

Draw 3D world as seen from the camera.