diff --git a/Documentation/Doxygen/Properties.dox b/Documentation/Doxygen/Properties.dox index c1bbe26f5d..874ab13800 100644 --- a/Documentation/Doxygen/Properties.dox +++ b/Documentation/Doxygen/Properties.dox @@ -1,184 +1,184 @@ /** \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 + */