diff --git a/Documentation/Doxygen/Properties.dox b/Documentation/Doxygen/Properties.dox index 48970fa3f5..015f2ed7f8 100644 --- a/Documentation/Doxygen/Properties.dox +++ b/Documentation/Doxygen/Properties.dox @@ -1,216 +1,216 @@ /** \page PropertiesPage The MITK Property Concept \section PropertyConcept The Concept Behind MITK Properties Properties belong to a datanode and contain information relevant to the handling of the node by MITK. They provide a place to store additional information which is not part of the actual data, and as such have no reason to be contained within the data/file itself, but might be needed for such things as rendering (e.g. transfer functions) or interaction (e.g. the name of the node). Propteries can be read an set: \code mitk::ColorProperty::Pointer colorProperty = dynamic_cast(node->GetProperty("color")); node->SetProperty( "IsTensorVolume", mitk::BoolProperty::New( true ) ); \endcode \section ListOfIndependentProperty A List Of Module Independent Properties \subsection FileManagement File Management -path - The physical path the file was loaded from -name - The node name in the datamanager -selected - Whether the node is selected in the datamanager + \subsection GenericRenderingProperty Generic Rendering Properties -color - Color the surface, grey value image, whatever should be rendered in -(default is usually white). There is a special mitk::ColorProperty and you -can use the Getter/Setter methods to access it. The color is defined with -three values (RGB) in the range between 0.0 and 1.0. -\info If you are inside a mapper you can use the following code to access + + \subsection SurfaceRenderingProperties Surface Rendering Properties -back color - in 2D, color of the normals outside the surface -back normal lenth (px) - in 2D, length of the normals in pixels + \subsection VolumeRenderingProperties Volume Rendering Properties -TransferFunction - contains transfer function for use in coloring image -volumerendering - Should the volume be rendered or not -volumerendering configuration - Choice between Composite und MIP -volumerendering.cpu.ambient - ambient lighting -volumerendering.cpu.diffuse - in-/decrease light dispersion -volumerendering.cpu.specular - in-/decrease non-scattered reflection -volumerendering.cpu.specular.power - control percentage of non-scattered + + + +\remark Uselod can be active with usegpu, usemip, useray, but any of the latter can not be used with another one of them. -\endinfo + \subsection PointSetProperties Point Set Properties close contour - Toggles whether the first and the last point of a contour (connecting pieces between following points of a pointset) are connected. contourcolor - Determines the color of the contour (connecting pieces between following points of a pointset). Visible only if "show contour" is active. contoursize - Represents the diameter of the contour (which is kind of a tube between the following points of a pointset). Visible only if "show contour" is active. distance decimal digits - Sets the number of decimal places for the euclidean point to point distance which can be displayed by activating "show distances". point 2D size - The positions of points in the 2D view are represented by crosses. "point 2D size" determines the size of this crosses. point line width - The positions of points in the 2D view are represented by crosses. "point line width" determines the thickness of this crosses. pointsize - The positions of points in the 3D view are represented by spheres. "pointsize" determines the diameter (size) of this spheres. selectedcolor - Sets the color for selected points from a pointset. show angles - If "show contour" is active the angles between two contour parts can be shown. show contour - Connects following points of a pointset by drawing connecting pieces between this points. show distance lines - Shows all angles and lines of the contour (in 2D views) even if they are not on the view's current slice. show distances - Draws lines between following points (in 2D views) and displays the euclidean distance between this points. show points - Toggles if the points are visible or not in the view. updateDataOnRender - If "true" the pointset is updated before rendering. If the pointset is part of a filter pipeline this also causes an update to the pipeline which sometimes may be not desired so it can be switched of by setting it to false. */