# 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::CChain Class Reference

A list of ordered chains of vertices, delimiting 2 surfaces. More...

#include <chain.h>

List of all members.

Public Methods

 CChain ()
 Constructor. More...

const std::vector< uint16 > & getSubChains () const
 Returns a vector of ordered chain ids that compose the entire chain. More...

uint16 getSubChain (uint n) const
 Returns the id of the nth ordered chain that composes the chain. More...

sint32 getLeft () const
 Returns the left surface id. More...

uint8 getLeftLoop () const
uint8 getLeftLoopIndex () const
sint32 getRight () const
 Returns the right surface id. More...

uint8 getRightLoop () const
uint8 getRightLoopIndex () const
float getLength () const
 returns the legnth of the whole chain. More...

sint32 getBorderChainIndex () const
 Gets the index of the chain on border (in the local retriever object.). More...

bool isBorderChain () const
 Returns true iff the chaion is a border chain. More...

uint16 getStartTip () const
 Returns the id of the start tip of the chain. More...

uint16 getStopTip () const
 Returns the id of the end tip of the chain. More...

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


Static Public Methods

bool isBorderChainId (sint32 id)
 Returns true iff the given id corresponds to a link on the border. More...

sint32 convertBorderChainId (sint32 id)
 Converts the surf id into the real index to the link (in the BorderChainLinks of the CRetrieverInstance.). More...

sint32 getDummyBorderChainId ()
 Returns true iff the chaion is a border chain. More...


Protected Methods

void make (const std::vector< NLMISC::CVector > &vertices, sint32 left, sint32 right, std::vector< COrderedChain > &chains, uint16 thisId, std::vector< COrderedChain3f > &fullChains)
 Build the whole surface from a vector of CVector and the left and right surfaces. More...

void setLoopIndexes (sint32 surface, uint loop, uint loopIndex)
void setBorderChainIndex (sint32 id)
void unify (std::vector< COrderedChain > &ochains)
void setStartVector (const CVector2s &v, std::vector< COrderedChain > &ochains)
void setStopVector (const CVector2s &v, std::vector< COrderedChain > &ochains)
CVector2s getStartVector (std::vector< COrderedChain > &ochains)
CVector2s getStopVector (std::vector< COrderedChain > &ochains)

Protected Attributes

std::vector< uint16 > _SubChains
 The list of ordered chains that compose the chain. More...

sint32 _Left
 The surface on the left of the chain. More...

sint32 _Right
 The surface on the right of the chain. More...

uint16 _StartTip
 The tips indexes in the retriever object. More...

uint16 _StopTip
float _Length
 The length of the whole chain. More...

uint8 _LeftLoop
uint8 _LeftLoopIndex
uint8 _RightLoop
uint8 _RightLoopIndex

Friends

class CRetrievableSurface
class CLocalRetriever

Detailed Description

A list of ordered chains of vertices, delimiting 2 surfaces.

Author:
Benjamin Legros , Nevrax France
Date:
2001

Definition at line 210 of file chain.h.

Constructor & Destructor Documentation

NLPACS::CChain::CChain (    )  [inline]
 

Constructor.

Definition at line 259 of file chain.h.

References _Left, _LeftLoop, _LeftLoopIndex, _Length, _Right, _RightLoop, _RightLoopIndex, _StartTip, and _StopTip.

Member Function Documentation

sint32 NLPACS::CChain::convertBorderChainId (  sint32    id )  [inline, static]
 

Converts the surf id into the real index to the link (in the BorderChainLinks of the CRetrieverInstance.).

Definition at line 291 of file chain.h.

References id.

Referenced by getBorderChainIndex, getDummyBorderChainId, and setBorderChainIndex.

sint32 NLPACS::CChain::getBorderChainIndex (    )  const [inline]
 

Gets the index of the chain on border (in the local retriever object.).

Definition at line 282 of file chain.h.

References _Right, convertBorderChainId, and isBorderChainId.

sint32 NLPACS::CChain::getDummyBorderChainId (    )  [inline, static]
 

Returns true iff the chaion is a border chain.

Definition at line 297 of file chain.h.

References convertBorderChainId.

sint32 NLPACS::CChain::getLeft (    )  const [inline]
 

Returns the left surface id.

Definition at line 269 of file chain.h.

References _Left.

uint8 NLPACS::CChain::getLeftLoop (    )  const [inline]
 

Definition at line 270 of file chain.h.

References _LeftLoop.

uint8 NLPACS::CChain::getLeftLoopIndex (    )  const [inline]
 

Definition at line 271 of file chain.h.

References _LeftLoopIndex.

float NLPACS::CChain::getLength (    )  const [inline]
 

returns the legnth of the whole chain.

Definition at line 279 of file chain.h.

References _Length.

sint32 NLPACS::CChain::getRight (    )  const [inline]
 

Returns the right surface id.

Definition at line 274 of file chain.h.

References _Right.

uint8 NLPACS::CChain::getRightLoop (    )  const [inline]
 

Definition at line 275 of file chain.h.

References _RightLoop.

uint8 NLPACS::CChain::getRightLoopIndex (    )  const [inline]
 

Definition at line 276 of file chain.h.

References _RightLoopIndex.

uint16 NLPACS::CChain::getStartTip (    )  const [inline]
 

Returns the id of the start tip of the chain.

Definition at line 300 of file chain.h.

References _StartTip.

CVector2s NLPACS::CChain::getStartVector (  std::vector< COrderedChain > &    ochains )  [protected]
 

uint16 NLPACS::CChain::getStopTip (    )  const [inline]
 

Returns the id of the end tip of the chain.

Definition at line 303 of file chain.h.

References _StopTip.

CVector2s NLPACS::CChain::getStopVector (  std::vector< COrderedChain > &    ochains )  [protected]
 

uint16 NLPACS::CChain::getSubChain (  uint    n )  const [inline]
 

Returns the id of the nth ordered chain that composes the chain.

Definition at line 266 of file chain.h.

References _SubChains.

const std::vector<uint16>& NLPACS::CChain::getSubChains (    )  const [inline]
 

Returns a vector of ordered chain ids that compose the entire chain.

Definition at line 263 of file chain.h.

References _SubChains.

bool NLPACS::CChain::isBorderChain (    )  const [inline]
 

Returns true iff the chaion is a border chain.

Definition at line 294 of file chain.h.

References _Right, and isBorderChainId.

bool NLPACS::CChain::isBorderChainId (  sint32    id )  [inline, static]
 

Returns true iff the given id corresponds to a link on the border.

Definition at line 288 of file chain.h.

References id.

Referenced by getBorderChainIndex, and isBorderChain.

void NLPACS::CChain::make (  const std::vector< NLMISC::CVector > &    vertices,
sint32    left,
sint32    right,
std::vector< COrderedChain > &    chains,
uint16    thisId,
std::vector< COrderedChain3f > &    fullChains
)  [protected]
 

Build the whole surface from a vector of CVector and the left and right surfaces.

void NLPACS::CChain::serial (  NLMISC::IStream &    f ) 
 

Serialises the CChain object.

Definition at line 262 of file chain.cpp.

References _Left, _LeftLoop, _LeftLoopIndex, _Length, _Right, _RightLoop, _RightLoopIndex, _StartTip, _StopTip, and _SubChains.

void NLPACS::CChain::setBorderChainIndex (  sint32    id )  [inline, protected]
 

Definition at line 254 of file chain.h.

References _Right, convertBorderChainId, and id.

void NLPACS::CChain::setLoopIndexes (  sint32    surface,
uint    loop,
uint    loopIndex
)  [inline, protected]
 

Definition at line 240 of file chain.h.

References _Left, _LeftLoop, _LeftLoopIndex, _RightLoop, and _RightLoopIndex.

void NLPACS::CChain::setStartVector (  const CVector2s &    v,
std::vector< COrderedChain > &    ochains
)  [protected]
 

void NLPACS::CChain::setStopVector (  const CVector2s &    v,
std::vector< COrderedChain > &    ochains
)  [protected]
 

void NLPACS::CChain::unify (  std::vector< COrderedChain > &    ochains )  [protected]
 

Friends And Related Function Documentation

friend class CLocalRetriever [friend]
 

Definition at line 214 of file chain.h.

friend class CRetrievableSurface [friend]
 

Definition at line 213 of file chain.h.

Member Data Documentation

sint32 NLPACS::CChain::_Left [protected]
 

The surface on the left of the chain.

Definition at line 220 of file chain.h.

Referenced by CChain, getLeft, serial, and setLoopIndexes.

uint8 NLPACS::CChain::_LeftLoop [protected]
 

Definition at line 232 of file chain.h.

Referenced by CChain, getLeftLoop, serial, and setLoopIndexes.

uint8 NLPACS::CChain::_LeftLoopIndex [protected]
 

Definition at line 232 of file chain.h.

Referenced by CChain, getLeftLoopIndex, serial, and setLoopIndexes.

float NLPACS::CChain::_Length [protected]
 

The length of the whole chain.

Definition at line 230 of file chain.h.

Referenced by CChain, getLength, and serial.

sint32 NLPACS::CChain::_Right [protected]
 

The surface on the right of the chain.

Definition at line 223 of file chain.h.

Referenced by CChain, getBorderChainIndex, getRight, isBorderChain, serial, and setBorderChainIndex.

uint8 NLPACS::CChain::_RightLoop [protected]
 

Definition at line 233 of file chain.h.

Referenced by CChain, getRightLoop, serial, and setLoopIndexes.

uint8 NLPACS::CChain::_RightLoopIndex [protected]
 

Definition at line 233 of file chain.h.

Referenced by CChain, getRightLoopIndex, serial, and setLoopIndexes.

uint16 NLPACS::CChain::_StartTip [protected]
 

The tips indexes in the retriever object.

Definition at line 226 of file chain.h.

Referenced by CChain, getStartTip, and serial.

uint16 NLPACS::CChain::_StopTip [protected]
 

Definition at line 227 of file chain.h.

Referenced by CChain, getStopTip, and serial.

std::vector<uint16> NLPACS::CChain::_SubChains [protected]
 

The list of ordered chains that compose the chain.

Definition at line 217 of file chain.h.

Referenced by getSubChain, getSubChains, and serial.

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