crystalspace.jbind.impl.engine.campos
Class csCameraPosition

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.engine.campos.csCameraPosition

All Implemented Interfaces:

iBase, iCameraPosition, iPointer

public class csCameraPosition

extends csBase

implements iCameraPosition

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csCameraPosition(iPointer nPointer)

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.
java.lang.String	getName() Return the name of the interface
csVector3	getPosition() Return the position.
java.lang.String	getSector() Return the home sector.
csVector3	getUpwardVector() Return the 'up' vector.
int	getVersion() Return the version of the interface
protected boolean	isNativePointerValidSafe(long pointer)
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 class crystalspace.jbind.impl.csutil.scf.csBase

decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

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

decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Constructor Detail

csCameraPosition

public csCameraPosition(iPointer nPointer)

Parameters:

nPointer -

Method Detail

getVersion

public int getVersion()

Description copied from interface: iBase

Return the version of the interface

Specified by:

getVersion in interface iBase

Specified by:

getVersion in class csBase

See Also:

iBase.getVersion()

getName

public java.lang.String getName()

Description copied from interface: iBase

Return the name of the interface

Specified by:

getName in interface iBase

Specified by:

getName in class csBase

See Also:

iBase.getName()

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)

Specified by:

isNativePointerValidSafe in class csNativeObject

See Also:

csNativeObject.isNativePointerValidSafe(long)

queryObject

public iObject queryObject()

Description copied from interface: iCameraPosition

Get the iObject for this camera position.

Specified by:

queryObject in interface iCameraPosition

Returns:

See Also:

iCameraPosition.queryObject()

Clone

public iCameraPosition Clone()

Description copied from interface: iCameraPosition

Create a clone this camera position.

Specified by:

Clone in interface iCameraPosition

Returns:

See Also:

iCameraPosition.Clone()

getSector

public java.lang.String getSector()

Description copied from interface: iCameraPosition

Return the home sector.

Specified by:

getSector in interface iCameraPosition

Returns:

See Also:

iCameraPosition.getSector()

setSector

public void setSector(java.lang.String Name)

Description copied from interface: iCameraPosition

Set the home sector.

Specified by:

setSector in interface iCameraPosition

Parameters:

Name -

See Also:

iCameraPosition.setSector(java.lang.String)

getPosition

public csVector3 getPosition()

Description copied from interface: iCameraPosition

Return the position.

Specified by:

getPosition in interface iCameraPosition

Returns:

See Also:

iCameraPosition.getPosition()

setPosition

public void setPosition(csVector3 p)

Description copied from interface: iCameraPosition

Set the position.

Specified by:

setPosition in interface iCameraPosition

Parameters:

p -

See Also:

iCameraPosition.setPosition(crystalspace.jbind.impl.csgeom.vector3.csVector3)

getUpwardVector

public csVector3 getUpwardVector()

Description copied from interface: iCameraPosition

Return the 'up' vector.

Specified by:

getUpwardVector in interface iCameraPosition

Returns:

See Also:

iCameraPosition.getUpwardVector()

setUpwardVector

public void setUpwardVector(csVector3 v)

Description copied from interface: iCameraPosition

Set the 'up' vector.

Specified by:

setUpwardVector in interface iCameraPosition

Parameters:

v -

See Also:

iCameraPosition.setUpwardVector(crystalspace.jbind.impl.csgeom.vector3.csVector3)

getForwardVector

public csVector3 getForwardVector()

Description copied from interface: iCameraPosition

Return the 'front' vector.

Specified by:

getForwardVector in interface iCameraPosition

Returns:

See Also:

iCameraPosition.getForwardVector()

setForwardVector

public void setForwardVector(csVector3 v)

Description copied from interface: iCameraPosition

Set the 'front' vector.

Specified by:

setForwardVector in interface iCameraPosition

Parameters:

v -

See Also:

iCameraPosition.setForwardVector(crystalspace.jbind.impl.csgeom.vector3.csVector3)

set

public void set(java.lang.String sector,
                csVector3 pos,
                csVector3 forward,
                csVector3 upward)

Description copied from interface: iCameraPosition

Set all attributes of the camera position.

Specified by:

set in interface iCameraPosition

Parameters:

sector -

pos -

forward -

upward -

See Also:

iCameraPosition.set(java.lang.String, crystalspace.jbind.impl.csgeom.vector3.csVector3, crystalspace.jbind.impl.csgeom.vector3.csVector3, crystalspace.jbind.impl.csgeom.vector3.csVector3)

load

public boolean load(iCamera cam,
                    iEngine e)

Description copied from interface: iCameraPosition

Load the camera position into a camera object.

Specified by:

load in interface iCameraPosition

Parameters:

cam -

e -

Returns:

See Also:

iCameraPosition.load(crystalspace.jbind.interfaces.iengine.camera.iCamera, crystalspace.jbind.interfaces.iengine.engine.iEngine)

setFarPlane

public void setFarPlane(csPlane3 pl)

Description copied from interface: iCameraPosition

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).

Specified by:

setFarPlane in interface iCameraPosition

Parameters:

pl -

See Also:

iCameraPosition.setFarPlane(crystalspace.jbind.impl.csgeom.plane3.csPlane3)

clearFarPlane

public void clearFarPlane()

Description copied from interface: iCameraPosition

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

Specified by:

clearFarPlane in interface iCameraPosition

See Also:

iCameraPosition.clearFarPlane()

getFarPlane

public csPlane3 getFarPlane()

Description copied from interface: iCameraPosition

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

Specified by:

getFarPlane in interface iCameraPosition

Returns:

See Also:

iCameraPosition.getFarPlane()