crystalspace.jbind.interfaces.iengine.campos
Interface iCameraPosition

All Superinterfaces:
iBase, iPointer
All Known Implementing Classes:
csCameraPosition

public interface iCameraPosition
extends iBase

A camera position.

This object can be used to initialize a camera object to a certain state.

It has the following properties:

Author:
java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiCameraPosition.php

Method Summary
 void clearFarPlane()
          Clear the far plane so no clipping will occur.
 iCameraPosition Clone()
          Create a clone this camera position.
 csPlane3 getFarPlane()
          Get the current far plane (or 0 if none is defined).
 csVector3 getForwardVector()
          Return the 'front' vector.
 csVector3 getPosition()
          Return the position.
 java.lang.String getSector()
          Return the home sector.
 csVector3 getUpwardVector()
          Return the 'up' vector.
 boolean load(iCamera cam, iEngine e)
          Load the camera position into a camera object.
 iObject queryObject()
          Get the iObject for this camera position.
 void set(java.lang.String sector, csVector3 pos, csVector3 forward, csVector3 upward)
          Set all attributes of the camera position.
 void setFarPlane(csPlane3 pl)
          Set the 3D far plane used to clip all geometry.
 void setForwardVector(csVector3 v)
          Set the 'front' vector.
 void setPosition(csVector3 p)
          Set the position.
 void setSector(java.lang.String Name)
          Set the home sector.
 void setUpwardVector(csVector3 v)
          Set the 'up' vector.
 
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

queryObject

public iObject queryObject()
Get the iObject for this camera position.

Returns:

Clone

public iCameraPosition Clone()
Create a clone this camera position.

Returns:

getSector

public java.lang.String getSector()
Return the home sector.

Returns:

setSector

public void setSector(java.lang.String Name)
Set the home sector.

Parameters:
Name -

getPosition

public csVector3 getPosition()
Return the position.

Returns:

setPosition

public void setPosition(csVector3 p)
Set the position.

Parameters:
p -

getUpwardVector

public csVector3 getUpwardVector()
Return the 'up' vector.

Returns:

setUpwardVector

public void setUpwardVector(csVector3 v)
Set the 'up' vector.

Parameters:
v -

getForwardVector

public csVector3 getForwardVector()
Return the 'front' vector.

Returns:

setForwardVector

public void setForwardVector(csVector3 v)
Set the 'front' vector.

Parameters:
v -

set

public void set(java.lang.String sector,
                csVector3 pos,
                csVector3 forward,
                csVector3 upward)
Set all attributes of the camera position.

Parameters:
sector -
pos -
forward -
upward -

load

public boolean load(iCamera cam,
                    iEngine e)
Load the camera position into a camera object.

Parameters:
cam -
e -
Returns:

setFarPlane

public void setFarPlane(csPlane3 pl)
Set the 3D far plane used to clip all geometry.
If the pointer is null then far plane clipping will be disabled.
Otherwise it will be enabled and the plane will be copied (so you can free or reuse the pointer you give here). Note that the far-plane will cull away geometry which is on the negative side of the plane (with csPlane3::Classify() function).

Parameters:
pl -

clearFarPlane

public void clearFarPlane()
Clear the far plane so no clipping will occur. This is equivalent to SetFarPlane(null).


getFarPlane

public csPlane3 getFarPlane()
Get the current far plane (or 0 if none is defined).

Returns: