[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [31631] branches/soc-2008-mxcurioni/source /blender/freestyle/intern/python/BPy_Freestyle.cpp: Documentation updates: Added a class hierarchy that shows

[Tamito Kajiyama]

Revision: 31631
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=31631
Author:   kjym3
Date:     2010-08-28 15:52:49 +0200 (Sat, 28 Aug 2010)

Log Message:
-----------
Documentation updates: Added a class hierarchy that shows
inheritance relationships among the classes defined in the
Freestyle module.

Modified Paths:
--------------
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Freestyle.cpp

Modified: branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Freestyle.cpp
===================================================================
--- branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Freestyle.cpp	2010-08-28 12:34:22 UTC (rev 31630)
+++ branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Freestyle.cpp	2010-08-28 13:52:49 UTC (rev 31631)
@@ -211,7 +211,226 @@
 
 /*-----------------------Freestyle module docstring----------------------------*/
 
-static char module_docstring[] = "The Blender Freestyle module\n\n";
+static char module_docstring[] =
+"This module provides classes for defining line drawing rules (such as\n"
+"predicates, functions, chaining iterators, and stroke shaders), as well\n"
+"as helper functions for style module writing.\n"
+"\n"
+"Class hierarchy:\n"
+"\n"
+"- :class:`BBox`\n"
+"- :class:`BinaryPredicate0D`\n"
+"- :class:`BinaryPredicate1D`\n"
+"\n"
+"  - :class:`FalseBP1D`\n"
+"  - :class:`Length2DBP1D`\n"
+"  - :class:`SameShapeIdBP1D`\n"
+"  - :class:`TrueBP1D`\n"
+"  - :class:`ViewMapGradientNormBP1D`\n"
+"\n"
+"- :class:`Id`\n"
+"- :class:`Interface0D`\n"
+"\n"
+"  - :class:`CurvePoint`\n"
+"\n"
+"    - :class:`StrokeVertex`\n"
+"\n"
+"  - :class:`SVertex`\n"
+"  - :class:`ViewVertex`\n"
+"\n"
+"    - :class:`NonTVertex`\n"
+"    - :class:`TVertex`\n"
+"\n"
+"- :class:`Interface1D`\n"
+"\n"
+"  - :class:`Curve`\n"
+"\n"
+"    - :class:`Chain`\n"
+"\n"
+"  - :class:`FEdge`\n"
+"\n"
+"    - :class:`FEdgeSharp`\n"
+"    - :class:`FEdgeSmooth`\n"
+"\n"
+"  - :class:`Stroke`\n"
+"  - :class:`ViewEdge`\n"
+"\n"
+"- :class:`Iterator`\n"
+"\n"
+"  - :class:`AdjacencyIterator`\n"
+"  - :class:`CurvePointIterator`\n"
+"  - :class:`Interface0DIterator`\n"
+"  - :class:`SVertexIterator`\n"
+"  - :class:`StrokeVertexIterator`\n"
+"  - :class:`ViewEdgeIterator`\n"
+"\n"
+"    - :class:`ChainingIterator`\n"
+"\n"
+"      - :class:`ChainPredicateIterator`\n"
+"      - :class:`ChainSilhouetteIterator`\n"
+"\n"
+"  - :class:`orientedViewEdgeIterator`\n"
+"\n"
+"- :class:`Material`\n"
+"- :class:`Noise`\n"
+"- :class:`Operators`\n"
+"- :class:`SShape`\n"
+"- :class:`StrokeAttribute`\n"
+"- :class:`StrokeShader`\n"
+"\n"
+"  - :class:`BackboneStretcherShader`\n"
+"  - :class:`BezierCurveShader`\n"
+"  - :class:`CalligraphicShader`\n"
+"  - :class:`ColorNoiseShader`\n"
+"  - :class:`ColorVariationPatternShader`\n"
+"  - :class:`ConstantColorShader`\n"
+"  - :class:`ConstantThicknessShader`\n"
+"  - :class:`ConstrainedIncreasingThicknessShader`\n"
+"  - :class:`GuidingLinesShader`\n"
+"  - :class:`IncreasingColorShader`\n"
+"  - :class:`IncreasingThicknessShader`\n"
+"  - :class:`PolygonalizationShader`\n"
+"  - :class:`SamplingShader`\n"
+"  - :class:`SmoothingShader`\n"
+"  - :class:`SpatialNoiseShader`\n"
+"  - :class:`StrokeTextureShader`\n"
+"  - :class:`TextureAssignerShader`\n"
+"  - :class:`ThicknessNoiseShader`\n"
+"  - :class:`ThicknessVariationPatternShader`\n"
+"  - :class:`TipRemoverShader`\n"
+"  - :class:`fstreamShader`\n"
+"  - :class:`streamShader`\n"
+"\n"
+"- :class:`UnaryFunction0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DDouble`\n"
+"\n"
+"    - :class:`Curvature2DAngleF0D`\n"
+"    - :class:`DensityF0D`\n"
+"    - :class:`GetProjectedXF0D`\n"
+"    - :class:`GetProjectedYF0D`\n"
+"    - :class:`GetProjectedZF0D`\n"
+"    - :class:`GetXF0D`\n"
+"    - :class:`GetYF0D`\n"
+"    - :class:`GetZF0D`\n"
+"    - :class:`LocalAverageDepthF0D`\n"
+"    - :class:`ZDiscontinuityF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DEdgeNature`\n"
+"\n"
+"    - :class:`CurveNatureF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DFloat`\n"
+"\n"
+"    - :class:`GetCurvilinearAbscissaF0D`\n"
+"    - :class:`GetParameterF0D`\n"
+"    - :class:`GetViewMapGradientNormF0D`\n"
+"    - :class:`ReadCompleteViewMapPixelF0D`\n"
+"    - :class:`ReadMapPixelF0D`\n"
+"    - :class:`ReadSteerableViewMapPixelF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DId`\n"
+"\n"
+"    - :class:`ShapeIdF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DMaterial`\n"
+"\n"
+"    - :class:`MaterialF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DUnsigned`\n"
+"\n"
+"    - :class:`QuantitativeInvisibilityF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DVec2f`\n"
+"\n"
+"    - :class:`Normal2DF0D`\n"
+"    - :class:`VertexOrientation2DF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DVec3f`\n"
+"\n"
+"    - :class:`VertexOrientation3DF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DVectorViewShape`\n"
+"\n"
+"    - :class:`GetOccludersF0D`\n"
+"\n"
+"  - :class:`UnaryFunction0DViewShape`\n"
+"\n"
+"    - :class:`GetOccludeeF0D`\n"
+"    - :class:`GetShapeF0D`\n"
+"\n"
+"- :class:`UnaryFunction1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DDouble`\n"
+"\n"
+"    - :class:`Curvature2DAngleF1D`\n"
+"    - :class:`DensityF1D`\n"
+"    - :class:`GetCompleteViewMapDensityF1D`\n"
+"    - :class:`GetDirectionalViewMapDensityF1D`\n"
+"    - :class:`GetProjectedXF1D`\n"
+"    - :class:`GetProjectedYF1D`\n"
+"    - :class:`GetProjectedZF1D`\n"
+"    - :class:`GetSteerableViewMapDensityF1D`\n"
+"    - :class:`GetViewMapGradientNormF1D`\n"
+"    - :class:`GetXF1D`\n"
+"    - :class:`GetYF1D`\n"
+"    - :class:`GetZF1D`\n"
+"    - :class:`LocalAverageDepthF1D`\n"
+"    - :class:`ZDiscontinuityF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DEdgeNature`\n"
+"\n"
+"    - :class:`CurveNatureF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DFloat`\n"
+"  - :class:`UnaryFunction1DUnsigned`\n"
+"\n"
+"    - :class:`QuantitativeInvisibilityF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DVec2f`\n"
+"\n"
+"    - :class:`Normal2DF1D`\n"
+"    - :class:`Orientation2DF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DVec3f`\n"
+"\n"
+"    - :class:`Orientation3DF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DVectorViewShape`\n"
+"\n"
+"    - :class:`GetOccludeeF1D`\n"
+"    - :class:`GetOccludersF1D`\n"
+"    - :class:`GetShapeF1D`\n"
+"\n"
+"  - :class:`UnaryFunction1DVoid`\n"
+"\n"
+"    - :class:`ChainingTimeStampF1D`\n"
+"    - :class:`IncrementChainingTimeStampF1D`\n"
+"    - :class:`TimeStampF1D`\n"
+"\n"
+"- :class:`UnaryPredicate0D`\n"
+"\n"
+"  - :class:`FalseUP0D`\n"
+"  - :class:`TrueUP0D`\n"
+"\n"
+"- :class:`UnaryPredicate1D`\n"
+"\n"
+"  - :class:`ContourUP1D`\n"
+"  - :class:`DensityLowerThanUP1D`\n"
+"  - :class:`EqualToChainingTimeStampUP1D`\n"
+"  - :class:`EqualToTimeStampUP1D`\n"
+"  - :class:`ExternalContourUP1D`\n"
+"  - :class:`FalseUP1D`\n"
+"  - :class:`QuantitativeInvisibilityUP1D`\n"
+"  - :class:`ShapeUP1D`\n"
+"  - :class:`TrueUP1D`\n"
+"\n"
+"- :class:`ViewMap`\n"
+"- :class:`ViewShape`\n"
+"- :class:`IntegrationType`\n"
+"- :class:`MediumType`\n"
+"- :class:`Nature`\n"
+"\n";
 
 /*-----------------------Freestyle module method def---------------------------*/