Python API documentation updates: a description of class hierarchy

was added to the docstrings of most Python extension types.
This commit is contained in:
2010-08-12 12:17:47 +00:00
parent dd75ec4907
commit f510faed6c
133 changed files with 266 additions and 1 deletions

View File

@@ -119,6 +119,8 @@ static PyModuleDef module_definition = {
/*-----------------------BPy_IntegrationType type definition ------------------------------*/
static char IntegrationType___doc__[] =
"Class hierarchy: int > :class:`IntegrationType`\n"
"\n"
"Different integration methods that can be invoked to integrate into a\n"
"single value the set of values obtained from each 0D element of an 1D\n"
"element:\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
/*-----------------------BPy_MediumType type definition ------------------------------*/
static char MediumType___doc__[] =
"Class hierarchy: int > :class:`MediumType`\n"
"\n"
"The different blending modes available to similate the interaction\n"
"media-medium:\n"
"\n"

View File

@@ -55,6 +55,8 @@ PyNumberMethods nature_as_number = {
/*-----------------------BPy_Nature docstring ------------------------------------*/
static char Nature___doc__[] =
"Class hierarchy: int > :class:`Nature`\n"
"\n"
"Different possible natures of 0D and 1D elements of the ViewMap.\n"
"\n"
"Vertex natures:\n"

View File

@@ -9,6 +9,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char FalseBP1D___doc__[] =
"Class hierarchy: :class:`BinaryPredicate1D` > :class:`FalseBP1D`\n"
"\n"
".. method:: __call__(inter1, inter2)\n"
"\n"
" Always returns false.\n"

View File

@@ -9,6 +9,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Length2DBP1D___doc__[] =
"Class hierarchy: :class:`BinaryPredicate1D` > :class:`Length2DBP1D`\n"
"\n"
".. method:: __call__(inter1, inter2)\n"
"\n"
" Returns true if the 2D length of inter1 is less than the 2D length\n"

View File

@@ -9,6 +9,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char SameShapeIdBP1D___doc__[] =
"Class hierarchy: :class:`BinaryPredicate1D` > :class:`SameShapeIdBP1D`\n"
"\n"
".. method:: __call__(inter1, inter2)\n"
"\n"
" Returns true if inter1 and inter2 belong to the same shape.\n"

View File

@@ -9,6 +9,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char TrueBP1D___doc__[] =
"Class hierarchy: :class:`BinaryPredicate1D` > :class:`TrueBP1D`\n"
"\n"
".. method:: __call__(inter1, inter2)\n"
"\n"
" Always returns true.\n"

View File

@@ -14,6 +14,8 @@ extern "C" {
//ViewMapGradientNormBP1D(int level, IntegrationType iType=MEAN, float sampling=2.0)
static char ViewMapGradientNormBP1D___doc__[] =
"Class hierarchy: :class:`BinaryPredicate1D` > :class:`ViewMapGradientNormBP1D`\n"
"\n"
".. method:: __call__(inter1, inter2)\n"
"\n"
" Returns true if the evaluation of the Gradient norm Function is\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char CurvePoint___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`CurvePoint`\n"
"\n"
"Class to represent a point of a curve. A CurvePoint can be any point\n"
"of a 1D curve (it doesn't have to be a vertex of the curve). Any\n"
":class:`Interface1D` is built upon ViewEdges, themselves built upon\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
static char SVertex___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`SVertex`\n"
"\n"
"Class to define a vertex of the embedding.\n"
"\n"
".. method:: __init__()\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ViewVertex___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex`\n"
"\n"
"Class to define a view vertex. A view vertex is a feature vertex\n"
"corresponding to a point of the image graph, where the characteristics\n"
"of an edge (e.g., nature and visibility) might change. A\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char StrokeVertex___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`CurvePoint` > :class:`StrokeVertex`\n"
"\n"
"Class to define a stroke vertex.\n"
"\n"
".. method:: __init__()\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char NonTVertex___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`NonTVertex`\n"
"\n"
"View vertex for corners, cusps, etc. associated to a single SVertex.\n"
"Can be associated to 2 or more view edges.\n"
"\n"

View File

@@ -15,6 +15,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char TVertex___doc__[] =
"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`TVertex`\n"
"\n"
"Class to define a T vertex, i.e. an intersection between two edges.\n"
"It points towards two SVertex and four ViewEdges. Among the\n"
"ViewEdges, two are front and the other two are back. Basically a\n"

View File

@@ -15,6 +15,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char FEdge___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`FEdge`\n"
"\n"
"Base Class for feature edges. This FEdge can represent a silhouette,\n"
"a crease, a ridge/valley, a border or a suggestive contour. For\n"
"silhouettes, the FEdge is oriented so that the visible face lies on\n"

View File

@@ -14,6 +14,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char FrsCurve___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`Curve`\n"
"\n"
"Base class for curves made of CurvePoints. :class:`SVertex` is the\n"
"type of the initial curve vertices. A :class:`Chain` is a\n"
"specialization of a Curve.\n"

View File

@@ -22,6 +22,8 @@ extern "C" {
// - is it even used ? not even in SWIG version
static char Stroke___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`Stroke`\n"
"\n"
"Class to define a stroke. A stroke is made of a set of 2D vertices\n"
"(:class:`StrokeVertex`), regularly spaced out. This set of vertices\n"
"defines the stroke's backbone geometry. Each of these stroke vertices\n"

View File

@@ -17,6 +17,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ViewEdge___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`ViewEdge`\n"
"\n"
"Class defining a ViewEdge. A ViewEdge in an edge of the image graph.\n"
"it connnects two :class:`ViewVertex` objects. It is made by connecting\n"
"a set of FEdges.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Chain___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`Curve` > :class:`Chain`\n"
"\n"
"Class to represent a 1D elements issued from the chaining process. A\n"
"Chain is the last step before the :class:`Stroke` and is used in the\n"
"Splitting and Creation processes.\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char FEdgeSharp___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`FEdge` > :class:`FEdgeSharp`\n"
"\n"
"Class defining a sharp FEdge. A Sharp FEdge corresponds to an initial\n"
"edge of the input mesh. It can be a silhouette, a crease or a border.\n"
"If it is a crease edge, then it is borded by two faces of the mesh.\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char FEdgeSmooth___doc__[] =
"Class hierarchy: :class:`Interface1D` > :class:`FEdge` > :class:`FEdgeSmooth`\n"
"\n"
"Class defining a smooth edge. This kind of edge typically runs across\n"
"a face of the input mesh. It can be a silhouette, a ridge or valley,\n"
"a suggestive contour.\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char AdjacencyIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`AdjacencyIterator`\n"
"\n"
"Class for representing adjacency iterators used in the chaining\n"
"process. An AdjacencyIterator is created in the increment() and\n"
"decrement() methods of a :class:`ChainingIterator` and passed to the\n"

View File

@@ -14,6 +14,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ChainPredicateIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator` > :class:`ChainingIterator` > :class:`ChainPredicateIterator`\n"
"\n"
"A \"generic\" user-controlled ViewEdge iterator. This iterator is in\n"
"particular built from a unary predicate and a binary predicate.\n"
"First, the unary predicate is evaluated for all potential next\n"

View File

@@ -15,6 +15,8 @@ extern "C" {
// ChainSilhouetteIterator (const ChainSilhouetteIterator &brother)
static char ChainSilhouetteIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator` > :class:`ChainingIterator` > :class:`ChainSilhouetteIterator`\n"
"\n"
"A ViewEdge Iterator used to follow ViewEdges the most naturally. For\n"
"example, it will follow visible ViewEdges of same nature. As soon, as\n"
"the nature or the visibility changes, the iteration stops (by setting\n"

View File

@@ -14,6 +14,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ChainingIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator` > :class:`ChainingIterator`\n"
"\n"
"Base class for chaining iterators. This class is designed to be\n"
"overloaded in order to describe chaining rules. It makes the\n"
"description of chaining rules easier. The two main methods that need\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char CurvePointIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`CurvePointIterator`\n"
"\n"
"Class representing an iterator on a curve. Allows an iterating\n"
"outside initial vertices. A CurvePoint is instanciated and returned\n"
"by getObject().\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Interface0DIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`Interface0DIterator`\n"
"\n"
"Class defining an iterator over Interface0D elements. An instance of\n"
"this iterator is always obtained from a 1D element.\n"
"\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char SVertexIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`SVertexIterator`\n"
"\n"
"Class representing an iterator over :class:`SVertex` of a\n"
":class:`ViewEdge`. An instance of an SVertexIterator can be obtained\n"
"from a ViewEdge by calling verticesBegin() or verticesEnd().\n"

View File

@@ -12,7 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char StrokeVertexIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`StrokeVertexIterator`\n"
"\n"
"Class defining an iterator designed to iterate over the\n"
":class:`StrokeVertex` of a :class:`Stroke`. An instance of a\n"
"StrokeVertexIterator can only be obtained from a Stroke by calling\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ViewEdgeIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`ViewEdgeIterator`\n"
"\n"
"Base class for iterators over ViewEdges of the :class:`ViewMap` Graph.\n"
"Basically the increment() operator of this class should be able to\n"
"take the decision of \"where\" (on which ViewEdge) to go when pointing\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char orientedViewEdgeIterator___doc__[] =
"Class hierarchy: :class:`Iterator` > :class:`orientedViewEdgeIterator`\n"
"\n"
"Class representing an iterator over oriented ViewEdges around a\n"
":class:`ViewVertex`. This iterator allows a CCW iteration (in the image\n"
"plane). An instance of an orientedViewEdgeIterator can only be\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char BackboneStretcherShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`BackboneStretcherShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(iAmount=2.0)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char BezierCurveShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`BezierCurveShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(error=4.0)\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char CalligraphicShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`CalligraphicShader`\n"
"\n"
"[Thickness Shader]\n"
"\n"
".. method:: __init__(iMinThickness, iMaxThickness, iOrientation, iClamp)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ColorNoiseShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ColorNoiseShader`\n"
"\n"
"[Color shader]\n"
"\n"
".. method:: __init__(iAmplitude, iPeriod)\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ColorVariationPatternShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ColorVariationPatternShader`\n"
"\n"
"[Color shader]\n"
"\n"
".. method:: __init__(pattern_name, stretch=True)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ConstantColorShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ConstantColorShader`\n"
"\n"
"[Color shader]\n"
"\n"
".. method:: __init__(iR, iG, iB, iAlpha=1.0)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ConstantThicknessShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ConstantThicknessShader`\n"
"\n"
"[Thickness shader]\n"
"\n"
".. method:: __init__(thickness)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ConstrainedIncreasingThicknessShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ConstrainedIncreasingThicknessShader`\n"
"\n"
"[Thickness shader]\n"
"\n"
".. method:: __init__(iThicknessMin, iThicknessMax, iRatio)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GuidingLinesShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`GuidingLinesShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(iOffset)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char IncreasingColorShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`IncreasingColorShader`\n"
"\n"
"[Color shader]\n"
"\n"
".. method:: __init__(iRm, iGm, iBm, iAlpham, iRM, iGM, iBM, iAlphaM)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char IncreasingThicknessShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`IncreasingThicknessShader`\n"
"\n"
"[Thickness shader]\n"
"\n"
".. method:: __init__(iThicknessA, iThicknessB)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char PolygonalizationShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`PolygonalizationShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(iError)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char SamplingShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`SamplingShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(sampling)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char SmoothingShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`SmoothingShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(iNbIteration, iFactorPoint, ifactorCurvature, iFactorCurvatureDifference, iAnisoPoint, iAnisNormal, iAnisoCurvature, icarricatureFactor)\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char SpatialNoiseShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`SpatialNoiseShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(iAmount, ixScale, nbOctave, smooth, pureRandom)\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char StrokeTextureShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`StrokeTextureShader`\n"
"\n"
"[Texture shader]\n"
"\n"
".. method:: __init__(textureFile, mediumType=MediumType.OPAQUE_MEDIUM, iTips=False)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char TextureAssignerShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`TextureAssignerShader`\n"
"\n"
"[Texture shader]\n"
"\n"
".. method:: __init__(id)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ThicknessNoiseShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ThicknessNoiseShader`\n"
"\n"
"[Thickness shader]\n"
"\n"
".. method:: __init__(iAmplitude, iPeriod)\n"

View File

@@ -12,6 +12,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ThicknessVariationPatternShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`ThicknessVariationPatternShader`\n"
"\n"
"[Thickness shader]\n"
"\n"
".. method:: __init__(pattern_name, iMinThickness, iMaxThickness, stretch)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char TipRemoverShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`TipRemoverShader`\n"
"\n"
"[Geometry shader]\n"
"\n"
".. method:: __init__(tipLength)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char fstreamShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`fstreamShader`\n"
"\n"
"[Output shader]\n"
"\n"
".. method:: __init__(iFileName)\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char streamShader___doc__[] =
"Class hierarchy: :class:`StrokeShader` > :class:`streamShader`\n"
"\n"
"[Output shader]\n"
"\n"
".. method:: __init__()\n"

View File

@@ -90,6 +90,8 @@ int UnaryFunction0DDouble_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DDouble___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a float value.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DEdgeNature_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DEdgeNature___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DEdgeNature`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a :class:`Nature` object.\n"
"\n"

View File

@@ -64,6 +64,8 @@ int UnaryFunction0DFloat_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DFloat___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a float value.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DId_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DId___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DId`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return an :class:`Id` object.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DMaterial_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DMaterial___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DMaterial`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a :class:`Material` object.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DUnsigned_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DUnsigned___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DUnsigned`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return an int value.\n"
"\n"

View File

@@ -40,6 +40,8 @@ int UnaryFunction0DVec2f_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DVec2f___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVec2f`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a 2D vector.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DVec3f_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DVec3f___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVec3f`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a 3D vector.\n"
"\n"

View File

@@ -34,6 +34,8 @@ int UnaryFunction0DVectorViewShape_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DVectorViewShape___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVectorViewShape`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a list of :class:`ViewShape`\n"
"objects.\n"

View File

@@ -40,6 +40,8 @@ int UnaryFunction0DViewShape_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DViewShape___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DViewShape`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a :class:`ViewShape` object.\n"
"\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ShapeIdF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DId` > :class:`ShapeIdF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a ShapeIdF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char MaterialF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DMaterial` > :class:`MaterialF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a MaterialF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char CurveNatureF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DEdgeNature` > :class:`CurveNatureF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a CurveNatureF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Normal2DF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVec2f` > :class:`Normal2DF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a Normal2DF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char VertexOrientation2DF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVec2f` > :class:`VertexOrientation2DF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a VertexOrientation2DF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char VertexOrientation3DF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVec3f` > :class:`VertexOrientation3DF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a VertexOrientation3DF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetOccludeeF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DViewShape` > :class:`GetOccludeeF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetOccludeeF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetShapeF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DViewShape` > :class:`GetShapeF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetShapeF0D.cpp object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Curvature2DAngleF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`Curvature2DAngleF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a Curvature2DAngleF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char DensityF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`DensityF0D`\n"
"\n"
".. method:: __init__(sigma=2.0)\n"
"\n"
" Builds a DensityF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedXF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedXF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetProjectedXF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedYF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedYF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetProjectedYF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedZF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedZF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetProjectedZF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetXF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetXF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetXF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetYF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetYF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetYF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetZF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetZF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetZF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char LocalAverageDepthF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`LocalAverageDepthF0D`\n"
"\n"
".. method:: __init__(maskSize=5.0)\n"
"\n"
" Builds a LocalAverageDepthF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ZDiscontinuityF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`ZDiscontinuityF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a ZDiscontinuityF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetCurvilinearAbscissaF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`GetCurvilinearAbscissaF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetCurvilinearAbscissaF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetParameterF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`GetParameterF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetParameterF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetViewMapGradientNormF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`GetViewMapGradientNormF0D`\n"
"\n"
".. method:: __init__(level)\n"
"\n"
" Builds a GetViewMapGradientNormF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ReadCompleteViewMapPixelF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`ReadCompleteViewMapPixelF0D`\n"
"\n"
".. method:: __init__(level)\n"
"\n"
" Builds a ReadCompleteViewMapPixelF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ReadMapPixelF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`ReadMapPixelF0D`\n"
"\n"
".. method:: __init__(iMapName, level)\n"
"\n"
" Builds a ReadMapPixelF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ReadSteerableViewMapPixelF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DFloat` > :class:`ReadSteerableViewMapPixelF0D`\n"
"\n"
".. method:: __init__(nOrientation, level)\n"
"\n"
" Builds a ReadSteerableViewMapPixelF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char QuantitativeInvisibilityF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DUnsigned` > :class:`QuantitativeInvisibilityF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a QuantitativeInvisibilityF0D object.\n"

View File

@@ -11,6 +11,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetOccludersF0D___doc__[] =
"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DVectorViewShape` > :class:`GetOccludersF0D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetOccludersF0D object.\n"

View File

@@ -114,6 +114,8 @@ int UnaryFunction1DDouble_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DDouble___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a float value.\n"
"\n"

View File

@@ -35,6 +35,8 @@ int UnaryFunction1DEdgeNature_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DEdgeNature___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DEdgeNature`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a :class:`Nature` object.\n"
"\n"

View File

@@ -28,6 +28,8 @@ int UnaryFunction1DFloat_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DFloat___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DFloat`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a float value.\n"
"\n"

View File

@@ -35,6 +35,8 @@ int UnaryFunction1DUnsigned_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DUnsigned___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DUnsigned`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return an int value.\n"
"\n"

View File

@@ -41,6 +41,8 @@ int UnaryFunction1DVec2f_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DVec2f___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVec2f`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a 2D vector.\n"
"\n"

View File

@@ -35,6 +35,8 @@ int UnaryFunction1DVec3f_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DVec3f___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVec3f`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a 3D vector.\n"
"\n"

View File

@@ -47,6 +47,8 @@ int UnaryFunction1DVectorViewShape_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DVectorViewShape___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVectorViewShape`\n"
"\n"
"Base class for unary functions (functors) that work on\n"
":class:`Interface1D` and return a list of :class:`ViewShape`\n"
"objects.\n"

View File

@@ -48,6 +48,8 @@ int UnaryFunction1DVoid_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction1DVoid___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVoid`\n"
"\n"
"Base class for unary functions (functors) working on\n"
":class:`Interface1D`.\n"
"\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char CurveNatureF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DEdgeNature` > :class:`CurveNatureF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a CurveNatureF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Normal2DF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVec2f` > :class:`Normal2DF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a Normal2DF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Orientation2DF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DVec2f` > :class:`Orientation2DF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds an Orientation2DF1D object.\n"

Some files were not shown because too many files have changed in this diff Show More