Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
DetailLayerBodyC::DetailLayerBodyC(void)
DetailLayerBodyC::DetailLayerBodyC(SArray1dC,SArray1dC,CTriSetC)
DetailLayerBodyC::DetailLayerBodyC(TriSetC,CTriSetC,PointMapperC::MapMode)
DetailLayerBodyC::Copy(void) const
DetailLayerBodyC::NumPoints(void) const
DetailLayerBodyC::NumFaces(void) const
DetailLayerBodyC::Base(void)
DetailLayerBodyC::Base(void) const
DetailLayerBodyC::DisplacementRange(DoubleT &,DoubleT &) const
DetailLayerBodyC::Point(IndexT) const
DetailLayerBodyC::Face(IndexT) const
BodyRefCounterVC::Copy(void) const
BodyRefCounterVC::operator==(const BodyRefCounterVC &) const
BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const
BodyRefCounterVC::Save(ostream &) const
BodyRefCounterC::AddReference(void)
BodyRefCounterC::RemoveReference(void)
BodyRefCounterC::SetConst(void) const
BodyRefCounterC::SetConst(void)
BodyRefCounterC::IsConst(void) const
BodyRefCounterC::IsNotConst(void) const
BodyRefCounterC::ToBeDeleted(void) const
BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void)
BodyRefCounterC::ToBeDeletedRemove(void)
BodyRefCounterC::BodyMightBeDeleted(void) const
BodyRefCounterC::IsCountZero(void) const
BodyRefCounterC::BRCPtrCanDeleteObject(void) const
BodyRefCounterC::Count(void) const
BodyRefCounterC::operator=(const BodyRefCounterC &)
BodyRefCounterC::IsValidObject(void) const
BodyRefCounterC::UserBitTest(IntT) const
BodyRefCounterC::UserBitSet(IntT,BooleanT)
BodyRefCounterC::UserBitZero(IntT)
BodyRefCounterC::ReportBRCError(char *)
BodyRefCounterC::Hash(void) const
BodyRefCounterC::SetUndeletable(void)
BodyRefCounterC::ReportInvalidObject(char *) const
RefCounterBaseC::Label(void) const
DetailLayerBodyC
 
A mesh mapped onto another
 
include "amma/DetailLayer.hh"
User Level:Default
Library: DispMap
Example: gendispmap.cc genmtri.cc
Section: 3D Surface.Displacement Mapping
In Scope:std

Comments:
This represents a detailed mesh which has been mapped onto the base mesh. This is a big object.

Parent Classes: Variables:
SArray1dC m_aPoints;

SArray1dC m_aFaces;

CTriSetC m_oBase;
Member Functions

Methods:
DetailLayerBodyC()
Default Constructor
Creates a DetailLayerBodyC with 0 DetailPoint entries

DetailLayerBodyC(SArray1dC<DetailPointC> aPoints,SArray1dC<TriC> aFaces,CTriSetC oBase)
Constructor from parameters
Creates a DetailLayerBodyC from the passed data

DetailLayerBodyC(TriSetC oDetail,CTriSetC oBase,PointMapperC::MapMode eMode = PointMapperC::MAP_BASIC)
Mapping Constructor
Creates a DetailLayerBodyC which is oDetail mapped onto oBase, using the specified mapping algorithm.

BodyRefCounterVC & Copy() const
new physical copy

SizeT NumPoints(void) const
Gets the size of the mapping
i.e. the number of data points.

SizeT NumFaces(void) const
Gets the size of the mesh
i.e. the number of faces.

CTriSetC Base(void)
Returns a handle to the base mesh.

const CTriSetC Base(void) const
Returns a const handle to the base mesh.

void DisplacementRange(DoubleT & dMin,DoubleT & dMax) const
Get the maximum and minumum values of the displacements

const DetailPointC & Point(IndexT iOffset) const
Returns the DetailPointC at entry

const TriC & Face(IndexT iOffset) const
Returns the TriC at entry

#include "amma/BRefCntV.hh"
BodyRefCounterVC & Copy() const
Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const
Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const
Compair identitys.

BooleanT Save(ostream & out) const
Save to ostream.

#include "amma/BRefCnt.hh"
void AddReference()
Another reference to the object has been created.

void RemoveReference()
One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const
This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)
This locks the object.

BooleanT IsConst(void) const
Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const
Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const
Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()
Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()
Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const
Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const
Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const
Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const
Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)
It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const
Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const
Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)
Test user flag.

void UserBitZero(IntT x)
Set bit to zero.

void ReportBRCError(char * Msg)
Report error, used in BRCPtrC.

UIntT Hash() const
Hash on address of object.

void SetUndeletable()
Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.

void ReportInvalidObject(char * Msg = 0) const
Tell user about validation failure.

#include "amma/RefCBase.hh"
LabelT Label() const
Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.


Programmer: James Smith, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001