Public API Reference

                 

---

iBCTerrState Struct Reference

This interface describes the API for the Bezier Curve terrain object. More...

#include <bcterr.h>

Inheritance diagram for iBCTerrState:

List of all members.

Public Methods
virtual void	SetSize (int x, int z)=0
	Set Number of Blocks across 2 axis.
virtual void	SetTopLeftCorner (const csVector3 &topleft)=0
	Set topleft corner.
virtual void	SetBlockMaterial (int x_block, int z_block, iMaterialWrapper *mat)=0
	Set Block info.
virtual void	SetHeightMap (iImage *im)=0
	Used to create control points, needs size to be set. Use for Debug only!
virtual int	HeightTest (csVector3 *point)=0
	Test the height at point, returns y + 2.0f.
virtual void	SetBlockMaterialNum (int num, iMaterialWrapper *mat)=0
	Set Block Material by grid number 0 = start.
virtual int	CameraHeightTest (csVector3 *point)=0
	CameraHeightTest should return a point that a camera can use.
virtual void	SetControlPoint (const csVector3 point, const int iter)=0
	Set control point by array position.
virtual void	SetControlPoint (const csVector3 point, const int x, const int z)=0
	Set control point by x / z position.
virtual void	SetControlPointHeight (const float height, const int iter)=0
	Set control point height.
virtual void	SetControlPointHeight (const float height, const int x, const int z)=0
	Set control point height.
virtual void	SetFlattenHeight (const float up, const float down, const float left, const float right)=0
	Set Height to flatten edges : default = topleft.y.
virtual void	DoFlatten (const bool up, const bool down, const bool left, const bool right)=0
	Make the MeshObject flatten it's edges, be sure not to set the height different for sides that touch.
virtual void	SetSystemInc (const int inc)=0
	Set System LOD increments.
virtual void	PreBuild ()=0
	Pre Build control points, should be called before setting height or control points.
virtual void	Build ()=0
	Build the mesh, prepare mesh for material calls.
virtual int	GetControlLength ()=0
	Length of control point array.
virtual bool	GetControlPoint (int iter, csVector3 &point)=0
	Get control point.

---

Detailed Description

This interface describes the API for the Bezier Curve terrain object.

Main creators of instances implementing this interface:

• BCTerr mesh object plugin (crystalspace.mesh.object.bcterr)
• iMeshObjectFactory::NewInstance()

Main ways to get pointers to this interface:

• SCF_QUERY_INTERFACE() on iMeshWrapper::GetMeshObject()

Main users of this interface:

• BCTerr Loader plugin (crystalspace.mesh.loader.bcterr)

Definition at line 58 of file bcterr.h.

---

Member Function Documentation

virtual void iBCTerrState::Build (    )  [pure virtual]

Build the mesh, prepare mesh for material calls.

virtual int iBCTerrState::CameraHeightTest (  csVector3 *    point )  [pure virtual]

CameraHeightTest should return a point that a camera can use.

virtual void iBCTerrState::DoFlatten (  const bool    up, const bool    down, const bool    left, const bool    right )  [pure virtual]

Make the MeshObject flatten it's edges, be sure not to set the height different for sides that touch.

virtual int iBCTerrState::GetControlLength (    )  [pure virtual]

Length of control point array.

virtual bool iBCTerrState::GetControlPoint (  int    iter, csVector3 &    point )  [pure virtual]

Get control point. iter: Starts at 0 and stops at GetControlLength () - 1. return true if successful

virtual int iBCTerrState::HeightTest (  csVector3 *    point )  [pure virtual]

Test the height at point, returns y + 2.0f.

virtual void iBCTerrState::PreBuild (    )  [pure virtual]

Pre Build control points, should be called before setting height or control points.

virtual void iBCTerrState::SetBlockMaterial (  int    x_block, int    z_block, iMaterialWrapper *    mat )  [pure virtual]

Set Block info.

virtual void iBCTerrState::SetBlockMaterialNum (  int    num, iMaterialWrapper *    mat )  [pure virtual]

Set Block Material by grid number 0 = start.

virtual void iBCTerrState::SetControlPoint (  const csVector3    point, const int    x, const int    z )  [pure virtual]

Set control point by x / z position.

virtual void iBCTerrState::SetControlPoint (  const csVector3    point, const int    iter )  [pure virtual]

Set control point by array position.

virtual void iBCTerrState::SetControlPointHeight (  const float    height, const int    x, const int    z )  [pure virtual]

Set control point height.

virtual void iBCTerrState::SetControlPointHeight (  const float    height, const int    iter )  [pure virtual]

Set control point height.

virtual void iBCTerrState::SetFlattenHeight (  const float    up, const float    down, const float    left, const float    right )  [pure virtual]

Set Height to flatten edges : default = topleft.y.

virtual void iBCTerrState::SetHeightMap (  iImage *    im )  [pure virtual]

Used to create control points, needs size to be set. Use for Debug only!

virtual void iBCTerrState::SetSize (  int    x, int    z )  [pure virtual]

Set Number of Blocks across 2 axis.

virtual void iBCTerrState::SetSystemInc (  const int    inc )  [pure virtual]

Set System LOD increments.

virtual void iBCTerrState::SetTopLeftCorner (  const csVector3 &    topleft )  [pure virtual]

Set topleft corner.

---

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

• imesh/bcterr.h

---