diff --git a/Core/Documentation/Doxygen/Concepts/Properties.dox b/Core/Documentation/Doxygen/Concepts/Properties.dox index e0cba92da5..ead012076b 100644 --- a/Core/Documentation/Doxygen/Concepts/Properties.dox +++ b/Core/Documentation/Doxygen/Concepts/Properties.dox @@ -1,226 +1,233 @@ /** \page PropertiesPage Properties \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: +Propteries can be read and set: \code -mitk::ColorProperty::Pointer colorProperty = dynamic_cast(node->GetProperty("color")); +//1: Read a property +mitk::Property::Pointer readProperty = node->GetProperty("color"); //read the property "color" from the data node +mitk::ColorProperty::Pointer colorProperty = dynamic_cast(readProperty); //cast this property to the subtype ColorProperty -node->SetProperty( "IsTensorVolume", mitk::BoolProperty::New( true ) ); +//2: Write a property +mitk::BoolProperty::Pointer newProperty = mitk::BoolProperty::New( true ); //create a new property, in this case a boolean property +node->SetProperty( "IsTensorVolume", newProperty ); //add this property to node with the key "IsTensorVolume" \endcode \section ListOfIndependentProperty A List Of Module Independent Properties +This section lists most of the known properties in MITK according to where they are used. Not every node needs each +(or even close to) of these properties. + \subsection FileManagement File Management \subsection GenericRenderingProperty Generic Rendering Properties \subsection SurfaceRenderingProperties Surface Rendering Properties \subsection VolumeRenderingProperties Volume Rendering Properties \remark Uselod can be active with usegpu, usemip, useray, but any of the latter can not be used with another one of them. \subsection PointSetProperties Point Set Properties Information on properties not in this list can be found in the appropriate module. \subsection PropertiesPageSeeAlso See Also */