# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLPACS::CRetrievableSurface Class Reference

A retrievable surface (inside a local surface retriever). More...

#include <retrievable_surface.h>

List of all members.

Public Types

enum  {
  IsFloorBit = 24, IsSlantBit = 25, IsCeilingBit = 26, IsUnderWaterBit = 27,
  NormalQuantasStartBit = 0, NormalQuantasStopBit = 3, NormalQuantasBitMask = 0x0000000f, CharacterQuantasStartBit = 8,
  CharacterQuantasStopBit = 11, CharacterQuantasBitMask = 0x00000f00, MaterialQuantasStartBit = 16, MaterialQuantasStopBit = 23,
  MaterialQuantasBitMask = 0x00ff0000
}

Public Methods

 CRetrievableSurface ()
uint8 getNormalQuanta () const
uint8 getOrientationQuanta () const
uint8 getMaterial () const
uint8 getCharacter () const
uint8 getLevel () const
bool isFloor () const
bool isCeiling () const
const CSurfaceQuadTreegetQuadTree () const
sint32 getTopology (uint model) const
uint32 getFlags () const
float getWaterHeight () const
const std::vector< CSurfaceLink > & getChains () const
 Gets links from this surface to its neighbors through chains... More...

CSurfaceLink getChain (uint n) const
 Gets nth link form this surface to its neighbor. More...

const NLMISC::CVectorgetCenter () const
void translate (const NLMISC::CVector &translation)
 Translates the surface by the translation vector. More...

void serial (NLMISC::IStream &f)
 Serialises the CRetrievableSurface. More...


Protected Attributes

uint32 _Flags
 Various flags. More...

float _WaterHeight
std::vector< CSurfaceLink_Chains
 The links to the neighbor surfaces. More...

std::vector< TLoop_Loops
 The loops of chains. More...

CSurfaceQuadTree _Quad
 A Height QuadTree that allows to easily find the height out for a given 2D point. More...

sint32 _Topologies [NumCreatureModels]
 The topologies associated with the surface, for each type of model. More...

NLMISC::CVector _Center
 The center of the surface. More...

Surface features.
uint8 _NormalQuanta
uint8 _OrientationQuanta
uint8 _Material
uint8 _Character
uint8 _Level
bool _IsFloor
bool _IsCeiling

Friends

class CLocalRetriever


Detailed Description

A retrievable surface (inside a local surface retriever).

It is composed of the Ids of the chains composing the border of the surface.

Author:
Benjamin Legros , Nevrax France
Date:
2001

Definition at line 67 of file retrievable_surface.h.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
IsFloorBit 
IsSlantBit 
IsCeilingBit 
IsUnderWaterBit 
NormalQuantasStartBit 
NormalQuantasStopBit 
NormalQuantasBitMask 
CharacterQuantasStartBit 
CharacterQuantasStopBit 
CharacterQuantasBitMask 
MaterialQuantasStartBit 
MaterialQuantasStopBit 
MaterialQuantasBitMask 

Definition at line 92 of file retrievable_surface.h.


Constructor & Destructor Documentation

NLPACS::CRetrievableSurface::CRetrievableSurface   [inline]
 

Definition at line 149 of file retrievable_surface.h.

References _Topologies, _WaterHeight, and NLPACS::NumCreatureModels.


Member Function Documentation

const NLMISC::CVector& NLPACS::CRetrievableSurface::getCenter   const [inline]
 

Definition at line 175 of file retrievable_surface.h.

CSurfaceLink NLPACS::CRetrievableSurface::getChain uint    n const [inline]
 

Gets nth link form this surface to its neighbor.

Definition at line 173 of file retrievable_surface.h.

References _Chains.

Referenced by NLPACS::CLocalRetriever::insurePosition.

const std::vector<CSurfaceLink>& NLPACS::CRetrievableSurface::getChains   const [inline]
 

Gets links from this surface to its neighbors through chains...

Definition at line 171 of file retrievable_surface.h.

References _Chains.

Referenced by NLPACS::CLocalRetriever::insurePosition.

uint8 NLPACS::CRetrievableSurface::getCharacter   const [inline]
 

Definition at line 161 of file retrievable_surface.h.

References _Character.

uint32 NLPACS::CRetrievableSurface::getFlags   const [inline]
 

Definition at line 167 of file retrievable_surface.h.

References _Flags.

uint8 NLPACS::CRetrievableSurface::getLevel   const [inline]
 

Definition at line 162 of file retrievable_surface.h.

References _Level.

uint8 NLPACS::CRetrievableSurface::getMaterial   const [inline]
 

Definition at line 160 of file retrievable_surface.h.

References _Material.

uint8 NLPACS::CRetrievableSurface::getNormalQuanta   const [inline]
 

Definition at line 158 of file retrievable_surface.h.

References _NormalQuanta.

uint8 NLPACS::CRetrievableSurface::getOrientationQuanta   const [inline]
 

Definition at line 159 of file retrievable_surface.h.

References _OrientationQuanta.

const CSurfaceQuadTree& NLPACS::CRetrievableSurface::getQuadTree   const [inline]
 

Definition at line 165 of file retrievable_surface.h.

References _Quad.

sint32 NLPACS::CRetrievableSurface::getTopology uint    model const [inline]
 

Definition at line 166 of file retrievable_surface.h.

References _Topologies.

float NLPACS::CRetrievableSurface::getWaterHeight   const [inline]
 

Definition at line 168 of file retrievable_surface.h.

References _WaterHeight.

bool NLPACS::CRetrievableSurface::isCeiling   const [inline]
 

Definition at line 164 of file retrievable_surface.h.

References _IsCeiling.

bool NLPACS::CRetrievableSurface::isFloor   const [inline]
 

Definition at line 163 of file retrievable_surface.h.

References _IsFloor.

void NLPACS::CRetrievableSurface::serial NLMISC::IStream   f
 

Serialises the CRetrievableSurface.

Definition at line 42 of file retrievable_surface.cpp.

References _Center, _Chains, _Character, _Flags, _IsCeiling, _IsFloor, _Level, _Loops, _Material, _NormalQuanta, _OrientationQuanta, _Quad, _Topologies, _WaterHeight, and NLPACS::NumCreatureModels.

void NLPACS::CRetrievableSurface::translate const NLMISC::CVector   translation [inline]
 

Translates the surface by the translation vector.

Definition at line 178 of file retrievable_surface.h.

References _Quad.


Friends And Related Function Documentation

friend class CLocalRetriever [friend]
 

Definition at line 110 of file retrievable_surface.h.


Member Data Documentation

NLMISC::CVector NLPACS::CRetrievableSurface::_Center [protected]
 

The center of the surface.

Definition at line 146 of file retrievable_surface.h.

Referenced by serial.

std::vector<CSurfaceLink> NLPACS::CRetrievableSurface::_Chains [protected]
 

The links to the neighbor surfaces.

Definition at line 134 of file retrievable_surface.h.

Referenced by getChain, getChains, and serial.

uint8 NLPACS::CRetrievableSurface::_Character [protected]
 

Definition at line 123 of file retrievable_surface.h.

Referenced by getCharacter, and serial.

uint32 NLPACS::CRetrievableSurface::_Flags [protected]
 

Various flags.

Definition at line 130 of file retrievable_surface.h.

Referenced by getFlags, and serial.

bool NLPACS::CRetrievableSurface::_IsCeiling [protected]
 

Definition at line 126 of file retrievable_surface.h.

Referenced by isCeiling, and serial.

bool NLPACS::CRetrievableSurface::_IsFloor [protected]
 

Definition at line 125 of file retrievable_surface.h.

Referenced by isFloor, and serial.

uint8 NLPACS::CRetrievableSurface::_Level [protected]
 

Definition at line 124 of file retrievable_surface.h.

Referenced by getLevel, and serial.

std::vector<TLoop> NLPACS::CRetrievableSurface::_Loops [protected]
 

The loops of chains.

Definition at line 137 of file retrievable_surface.h.

Referenced by serial.

uint8 NLPACS::CRetrievableSurface::_Material [protected]
 

Definition at line 122 of file retrievable_surface.h.

Referenced by getMaterial, and serial.

uint8 NLPACS::CRetrievableSurface::_NormalQuanta [protected]
 

Definition at line 120 of file retrievable_surface.h.

Referenced by getNormalQuanta, and serial.

uint8 NLPACS::CRetrievableSurface::_OrientationQuanta [protected]
 

Definition at line 121 of file retrievable_surface.h.

Referenced by getOrientationQuanta, and serial.

CSurfaceQuadTree NLPACS::CRetrievableSurface::_Quad [protected]
 

A Height QuadTree that allows to easily find the height out for a given 2D point.

Definition at line 140 of file retrievable_surface.h.

Referenced by getQuadTree, serial, and translate.

sint32 NLPACS::CRetrievableSurface::_Topologies[NumCreatureModels] [protected]
 

The topologies associated with the surface, for each type of model.

Definition at line 143 of file retrievable_surface.h.

Referenced by CRetrievableSurface, getTopology, and serial.

float NLPACS::CRetrievableSurface::_WaterHeight [protected]
 

Definition at line 131 of file retrievable_surface.h.

Referenced by CRetrievableSurface, getWaterHeight, and serial.


The documentation for this class was generated from the following files: