Main Page Modules Class Hierarchy Compound List File List Compound Members File Members Related Pages
WarpAlgorithm Class Reference
The abstract parent class of algorithms.
More...
#include <WarpAlgorithm.h>
Inheritance diagram for WarpAlgorithm::
List of all members.Public Methods
|
|
Protected Attributes
Detailed Description
This is an abstract parent class for different algorithm variants that could have been implemented during the work on this project. This class is used for calling the methods from the main effect class.
The main information in this class is:
- constant edges: It is possible to specify additional edges which don't change position in the warping process. E.g. this is used in order to force the image in a constant frame when the "frame as edges"-option is enabled. Note: The data structures for the constant edges are provided by derived classes.
- vertex grid pointer: Each instance of a WarpAlgorithm derivate receives a pointer to an CVertexGrid instance at startup via the setVertexGrid() method that holds the vertices being warped. .
Additional functionality:
- parameters: WarpAlgorithm derivates can declare parameters which influence the warp result. The number and type of the parameters is arbitrary.
- precalculations: WarpAlgorithm derivates can do some precalculation with the original contour. This is useful if the original contour stays fixed for a longer time than the transformed contour and the algorithm can do some precalculations only depending of the original contour. .
Member Function Documentation
void WarpAlgorithm::doPrecalculation (
|
PolygonShape * origShape ) [pure virtual]
|
|
|
Allows the algorithm to do some precalculations only depending of the original contour. -
Parameters:
-
origShape
|
The original contour |
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::undoPrecalculation (
|
) [pure virtual]
|
|
|
Most kinds of precalculations as e.g. caching allocates some memory so this method allows the WarpAlgorithm derivate to free it up.
Reimplemented in WarpAlgorithm1. |
|
The main vertex grid warping method. -
Parameters:
-
origShape
|
The original contour |
trafoShape
|
The warped contour |
vPlaneNormal
|
The normal vector of the plane in which the image lies. |
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::setParam (
|
int ParamID,
|
|
void * pValue ) [pure virtual]
|
|
|
-
Parameters:
-
ParamID
|
parameter ID |
pValue
|
pointer to the parameter (which type is unknown) |
Reimplemented in WarpAlgorithm1. |
void * WarpAlgorithm::getParam (
|
int ParamID ) [pure virtual]
|
|
|
-
Parameters:
-
-
Returns:
-
a pointer to a parameter (of unknown type)
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::getParamInfo (
|
int ParamID,
|
|
paramInfo & descr ) [pure virtual]
|
|
bool WarpAlgorithm::doesPrecalculation (
|
) [pure virtual]
|
|
|
-
Returns:
-
whether the algorithm does optimizations with precalculation
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::setConstantEdges (
|
Edge * pEdges,
|
|
int numEdges ) [pure virtual]
|
|
|
-
Parameters:
-
pEdges
|
pointer to an array of edges |
numEdges
|
number of edges in the array |
Reimplemented in WarpAlgorithm1. |
int WarpAlgorithm::getConstantEdgeCount (
|
) [pure virtual]
|
|
|
-
Returns:
-
The number of constant edges
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::getConstantEdges (
|
Edge * pEdges,
|
|
int maxEdges ) [pure virtual]
|
|
|
-
Parameters:
-
pEdges
|
pointer to an array to be filled with the edges |
maxEdges
|
maximal number of edges that have place in the array |
Reimplemented in WarpAlgorithm1. |
void WarpAlgorithm::useConstantEdges (
|
bool value ) [inline, virtual]
|
|
|
-
Parameters:
-
value
|
true, if constant edges are used in the warp algorithm. |
Reimplemented in WarpAlgorithm1. |
bool WarpAlgorithm::getUseConstantEdges (
|
) [inline, virtual]
|
|
|
-
Returns:
-
whether constant edges are used in the warp algorithm.
|
void WarpAlgorithm::setVertexGrid (
|
CVertexGrid * vertexGrid ) [inline, virtual]
|
|
CVertexGrid * WarpAlgorithm::getVertexGrid (
|
) [inline, virtual]
|
|
|
-
Returns:
-
The vertex grid pointer
|
Member Data Documentation
bool WarpAlgorithm::bUseConstantEdges [protected]
|
|
|
A flag for enabling and disabling the integration of the constant edges in the calculation. |
The documentation for this class was generated from the following file:
Generated at Fri Apr 19 16:53:07 2002 for GLFramework by
1.2.6 written by Dimitri van Heesch,
© 1997-2001