NL3D::CPortal Class Reference

#include <portal.h>

---

Detailed Description

CPortal

Author:

Matthieu Besson

Nevrax France

Date:

2001

Definition at line 55 of file portal.h.

Public Member Functions
bool	clipPyramid (NLMISC::CVector &observer, std::vector< NLMISC::CPlane > &pyramid)
bool	clipRay (const NLMISC::CVector &start, const NLMISC::CVector &end)
	return true if the portal clip the segment
	CPortal ()
CCluster *	getCluster (uint pos)
	return the cluster linked to the portal
std::string	getName ()
uint8	getNbCluster ()
	return the number of clusters linked to the portal
const std::vector< NLMISC::CVector > &	getPoly ()
void	getPoly (std::vector< NLMISC::CVector > &dest) const
	get this cluster poly in local coordinates
bool	isInFront (NLMISC::CVector &v)
	Return true if the vertex v is in front of the portal.
bool	isOpened ()
void	open (bool opened)
void	resetClusterLinks ()
	set all link to clusters to NULL.
void	serial (NLMISC::IStream &f)
	Serial.
bool	setCluster (CCluster *cluster)
	return false if more than 2 clusters added
void	setName (std::string &name)
bool	setPoly (const std::vector< NLMISC::CVector > &poly)
	return false if the polygon is not convex
void	setWorldMatrix (const NLMISC::CMatrix &WM)
const std::string &	getOcclusionModel ()
uint	getOcclusionModelId ()
const std::string &	getOpenOcclusionModel ()
uint	getOpenOcclusionModelId ()
void	setOcclusionModel (const std::string &occlusionModel)
void	setOpenOcclusionModel (const std::string &occlusionModel)
Private Attributes
CCluster *	_Clusters [2]
std::vector< NLMISC::CVector >	_LocalPoly
std::string	_Name
NLMISC::TStringId	_OcclusionModelId
bool	_Opened
NLMISC::TStringId	_OpenOcclusionModelId
std::vector< NLMISC::CVector >	_Poly
Friends
class	CInstanceGroup
	Friend class.

---

Constructor & Destructor Documentation

NL3D::CPortal::CPortal (   )

Definition at line 48 of file portal.cpp. References _OcclusionModelId, _Opened, and _OpenOcclusionModelId. { _Clusters[0] = _Clusters[1] = NULL; _Opened = true; _OcclusionModelId = CStringMapper::map("no occlusion"); _OpenOcclusionModelId = CStringMapper::map("no occlusion"); }

---

Member Function Documentation

bool NL3D::CPortal::clipPyramid (  NLMISC::CVector &  observer, std::vector< NLMISC::CPlane > &  pyramid )

Clip the view pyramid (all planes pass through observer point) against the portal Returns: false if the pyramid is completly clipped Definition at line 83 of file portal.cpp. References _Opened, _Poly, NLMISC::CPolygon::clip(), uint, and NLMISC::CPolygon::Vertices. Referenced by NL3D::CCluster::recursTraverseClip(). { if (!_Opened || _Poly.size()<3) return false; // Clip portal with pyramid CPolygon p; p.Vertices = _Poly; p.clip( &pyramid[1], pyramid.size()-1 ); // Construct pyramid with clipped portal if( p.Vertices.size() > 2 ) { uint i; // Found the right orientation CVector n = (p.Vertices[1]-p.Vertices[0])^(p.Vertices[2]-p.Vertices[0]); if( ((observer-p.Vertices[0])*n) < 0.0f ) { // Invert vertices for( i = 0; i < (p.Vertices.size()/2); ++i ) { CVector tmp = p.Vertices[i]; p.Vertices[i] = p.Vertices[p.Vertices.size()-1-i]; p.Vertices[p.Vertices.size()-1-i] = tmp; } } // Make pyramid : preserve 0 and 1 plane which are near and far plane pyramid.resize (p.Vertices.size()+2); for( i = 0; i < (p.Vertices.size()); ++i ) { pyramid[i+2].make( observer, p.Vertices[i], p.Vertices[(i+1)%p.Vertices.size()] ); } return true; } return false; }

bool NL3D::CPortal::clipRay (  const NLMISC::CVector &  start, const NLMISC::CVector &  end )

return true if the portal clip the segment Definition at line 262 of file portal.cpp. References _Poly, NLMISC::CPlane::d, NLMISC::CPlane::getNormal(), NLMISC::CPlane::make(), sint, and uint. Referenced by NL3D::CCluster::cameraRayClip(). { if(_Poly.size()<3) return false; // Avoid precision problem, make local to poly const CVector &refVert= _Poly[0]; CVector start= startWorld - refVert; CVector end= endWorld - refVert; // compute the plane of this poly, local to polygon CPlane plane; plane.make(CVector::Null, _Poly[1] - refVert, _Poly[2] - refVert); CVector normal = plane.getNormal(); float np1 = normal*end; float np2 = np1-normal*start; if (np2 == 0.0f) return false; float lambda = (plane.d+np1)/np2; // Checks the intersection belongs to the segment if (lambda < 0 || lambda > 1.0f) return false; // The intersection on the plane CVector hit = start*lambda+end*(1.0f-lambda); // Do convex test on each border sint sign= 0; uint polySize= _Poly.size(); for(uint i=0;i<polySize;i++) { const CVector v0= _Poly[i] - refVert; const CVector v1= _Poly[(i+1)%polySize] - refVert; float d = ((v1-v0)^normal)*(hit-v0); if(d<0) { if(sign==1) return false; else sign=-1; } else if(d>0) { if(sign==-1) return false; else sign=1; } else return false; } // all on same side, ok! return true; }

CCluster* NL3D::CPortal::getCluster (  uint  pos  )  [inline]

return the cluster linked to the portal Definition at line 84 of file portal.h. References uint. Referenced by NL3D::CCluster::cameraRayClip(), and NL3D::CCluster::recursTraverseClip(). { return _Clusters[pos]; }

std::string NL3D::CPortal::getName (  void   )  [inline]

Definition at line 101 of file portal.h. { return _Name; }

uint8 NL3D::CPortal::getNbCluster (   )

return the number of clusters linked to the portal Definition at line 156 of file portal.cpp. References uint8. { uint8 nRet = 0; if( _Clusters[0] != NULL ) nRet++; if( _Clusters[1] != NULL ) nRet++; return nRet; }

const std::string & NL3D::CPortal::getOcclusionModel (   )

Definition at line 60 of file portal.cpp. References _OcclusionModelId. { return CStringMapper::unmap(_OcclusionModelId); }

uint NL3D::CPortal::getOcclusionModelId (   )

Definition at line 64 of file portal.cpp. References _OcclusionModelId, and uint. { return _OcclusionModelId; }

const std::string & NL3D::CPortal::getOpenOcclusionModel (   )

Definition at line 72 of file portal.cpp. References _OpenOcclusionModelId. { return CStringMapper::unmap(_OpenOcclusionModelId); }

uint NL3D::CPortal::getOpenOcclusionModelId (   )

Definition at line 76 of file portal.cpp. References _OpenOcclusionModelId, and uint. { return _OpenOcclusionModelId; }

const std::vector<NLMISC::CVector>& NL3D::CPortal::getPoly (   )  [inline]

Definition at line 91 of file portal.h. References _LocalPoly. {return _LocalPoly;}

void NL3D::CPortal::getPoly (  std::vector< NLMISC::CVector > &  dest  )  const

get this cluster poly in local coordinates Definition at line 209 of file portal.cpp. References _LocalPoly. { dest = _LocalPoly; }

bool NL3D::CPortal::isInFront (  NLMISC::CVector &  v  )

Return true if the vertex v is in front of the portal. Definition at line 121 of file portal.cpp. References _Poly, and v. Referenced by NL3D::CCluster::recursTraverseClip(). { if( _Poly.size()<3 ) return false; CVector v1 = _Poly[1] - _Poly[0]; CVector v2 = _Poly[2] - _Poly[0]; CVector n = v1^v2; CVector pv = v - _Poly[0]; return ((n*pv) > 0.0f); }

bool NL3D::CPortal::isOpened (   )  [inline]

Definition at line 104 of file portal.h. References _Opened. { return _Opened; }

void NL3D::CPortal::open (  bool  opened  )  [inline]

Definition at line 103 of file portal.h. References _Opened. { _Opened = opened; }

void NL3D::CPortal::resetClusterLinks (   )

set all link to clusters to NULL. Accessors --------- Definition at line 134 of file portal.cpp. { _Clusters[0] = _Clusters[1] = NULL; }

void NL3D::CPortal::serial (  NLMISC::IStream &  f  )

Serial. Definition at line 216 of file portal.cpp. References _LocalPoly, _OcclusionModelId, _OpenOcclusionModelId, _Poly, NLMISC::IStream::isReading(), NLMISC::IStream::serial(), NLMISC::IStream::serialCont(), and NLMISC::IStream::serialVersion(). { int version = f.serialVersion (1); f.serialCont (_LocalPoly); if (f.isReading()) _Poly = _LocalPoly; f.serial (_Name); if (version >= 1) { if (f.isReading()) { std::string occName; f.serial(occName); if (occName.empty()) occName = "no occlusion"; _OcclusionModelId = CStringMapper::map(occName); f.serial(occName); if (occName.empty()) occName = "no occlusion"; _OpenOcclusionModelId = CStringMapper::map(occName); } else { std::string occName = CStringMapper::unmap(_OcclusionModelId); if (occName == "no occlusion") occName = ""; f.serial(occName); occName = CStringMapper::unmap(_OpenOcclusionModelId); if (occName == "no occlusion") occName = ""; f.serial(occName); } } }

bool NL3D::CPortal::setCluster (  CCluster *  cluster  )

return false if more than 2 clusters added Definition at line 140 of file portal.cpp. { if( _Clusters[0] == NULL ) { _Clusters[0] = cluster; return true; } if( _Clusters[1] == NULL ) { _Clusters[1] = cluster; return true; } return false; }

void NL3D::CPortal::setName (  std::string &  name  )  [inline]

Definition at line 99 of file portal.h. { _Name = name; }

void NL3D::CPortal::setOcclusionModel (  const std::string &  occlusionModel  )

Definition at line 56 of file portal.cpp. References _OcclusionModelId. { _OcclusionModelId = CStringMapper::map(occlusionModel); }

void NL3D::CPortal::setOpenOcclusionModel (  const std::string &  occlusionModel  )

Definition at line 68 of file portal.cpp. References _OpenOcclusionModelId. { _OpenOcclusionModelId = CStringMapper::map(occlusionModel); }

bool NL3D::CPortal::setPoly (  const std::vector< NLMISC::CVector > &  poly  )

return false if the polygon is not convex Todo: check if the polygon has the good orientation Definition at line 167 of file portal.cpp. References _LocalPoly, _Poly, NLMISC::CPlane::make(), NLMISC::CPlane::normalize(), PORTALPRECISION, and uint. { uint i; if( poly.size() < 3 ) return false; // Check if the polygon is a plane CPlane p; p.make( poly[0], poly[1], poly[2] ); p.normalize(); float dist; for( i = 0; i < (poly.size()-3); ++i ) { dist = fabsf(p*poly[i+3]); if( dist > PORTALPRECISION ) return false; } // Check if the polygon is convex /* CPlane p2; for( i = 0; i < (poly.size()-1); ++i ) { p2.make( poly[i], poly[i+1], poly[i]+p.getNormal() ); for( j = 0; j < poly.size(); ++j ) if( (j != i) && (j != i+1) ) { if( p2*poly[j] < 0.0f ) return false; } }*/ // Set the value _LocalPoly = poly; _Poly = poly; return true; }

void NL3D::CPortal::setWorldMatrix (  const NLMISC::CMatrix &  WM  )

Definition at line 255 of file portal.cpp. References _LocalPoly, _Poly, NLMISC::CMatrix::mulPoint(), and uint32. Referenced by NL3D::CInstanceGroup::addToSceneWhenAllShapesLoaded(), and NL3D::CCluster::traverseHrc(). { for (uint32 i = 0; i < _LocalPoly.size(); ++i) _Poly[i] = WM.mulPoint(_LocalPoly[i]); }

---

Friends And Related Function Documentation

friend class CInstanceGroup [friend]

Friend class. Definition at line 136 of file portal.h.

---

Field Documentation

CCluster* NL3D::CPortal::_Clusters[2] [private]

Definition at line 121 of file portal.h.

std::vector<NLMISC::CVector> NL3D::CPortal::_LocalPoly [private]

Definition at line 126 of file portal.h. Referenced by getPoly(), serial(), setPoly(), and setWorldMatrix().

std::string NL3D::CPortal::_Name [private]

Definition at line 123 of file portal.h.

NLMISC::TStringId NL3D::CPortal::_OcclusionModelId [private]

Definition at line 131 of file portal.h. Referenced by CPortal(), getOcclusionModel(), getOcclusionModelId(), serial(), and setOcclusionModel().

bool NL3D::CPortal::_Opened [private]

Definition at line 124 of file portal.h. Referenced by clipPyramid(), CPortal(), isOpened(), and open().

NLMISC::TStringId NL3D::CPortal::_OpenOcclusionModelId [private]

Definition at line 132 of file portal.h. Referenced by CPortal(), getOpenOcclusionModel(), getOpenOcclusionModelId(), serial(), and setOpenOcclusionModel().

std::vector<NLMISC::CVector> NL3D::CPortal::_Poly [private]

Definition at line 127 of file portal.h. Referenced by clipPyramid(), clipRay(), isInFront(), serial(), setPoly(), and setWorldMatrix().

---

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

• portal.h
• portal.cpp

---