![]() |
Computer Assited Medical Intervention Tool Kit
version 3.3
|
A special class to manage the basic structural component properties. More...
#include <BasicSCProperties.h>
Public Types | |
enum | Color { DEFAULT, RED, GREEN, BLUE, GRAY, OTHER } |
Default color settings. More... | |
Public Member Functions | |
BasicSCProperties (PhysicalModel *p, const Color c) | |
use a Color constant to set the color More... | |
BasicSCProperties (PhysicalModel *p, xmlNodePtr node) | |
BasicSCProperties (PhysicalModel *p, const Color c, const std::string n) | |
BasicSCProperties (PhysicalModel *p, const double *rgb) | |
use a double[3] array to set the color More... | |
BasicSCProperties (PhysicalModel *p, const double *rgb, const std::string n) | |
BasicSCProperties (PhysicalModel *p, const double r, const double g, const double b) | |
use 3 floats to set the color More... | |
BasicSCProperties (PhysicalModel *p, const double r, const double g, const double b, const std::string n) | |
BasicSCProperties (PhysicalModel *p) | |
defaultcolor is gray More... | |
BasicSCProperties (PhysicalModel *p, const std::string n) | |
double | getAlpha () const |
double | getBlue () const |
Color | getColor () const |
double | getGreen () const |
RenderingMode::Mode | getMode () const |
std::string | getModeString () const |
get the string equivalent to the enum rendering mode More... | |
double | getRed () const |
double * | getRGB () const |
double * | getRGBA () const |
bool | isVisible (const RenderingMode::Mode mode) const |
void | setAlpha (const double a) |
void | setBlue (const double b) |
void | setColor (Color c) |
void | setGreen (const double g) |
void | setMode (const RenderingMode::Mode) |
void | setRed (const double r) |
void | setRGB (const double *rgb) |
void | setRGB (const double r, const double g, const double b) |
void | setRGBA (const double r, const double g, const double b, const double a) |
void | setRGBA (const double *rgba) |
void | setVisible (const RenderingMode::Mode, const bool) |
virtual void | xmlPrint (std::ostream &)=0 |
print to an output stream in "pseaudo" XML format. More... | |
virtual | ~BasicSCProperties () |
![]() | |
std::string | getName () const |
get the name (be careful, this method DOES NOT return a copy, so you got the direct ptr to the name!!!) More... | |
PhysicalModel * | getPhysicalModel () const |
get the physical model More... | |
Properties (const std::string n="") | |
A nice simple constructor, with a given name. More... | |
Properties (PhysicalModel *, const std::string n="") | |
Another nice constructor, with the PM and a name. More... | |
void | setName (std::string) |
set the name (use the string = operator) More... | |
void | setPhysicalModel (PhysicalModel *) |
set the physical model More... | |
virtual | ~Properties () |
The default destructor. More... | |
void | domToFields (xmlNodePtr node) |
convert the xml node parameters to data fields More... | |
unsigned int | numberOfFields () const |
get the number of extra fields found in the PML More... | |
bool | isAField (std::string attName) const |
check if the field exist in the XML document, return false if it does not More... | |
std::string | getField (unsigned int) const |
get the name of field of given index More... | |
double | getDouble (std::string attName) |
field accessor: get the field attName as a double value, if field does not exist, 0.0 is return More... | |
int | getInt (std::string attName) const |
field accessor: get the field attName as an int value, if field does not exist, 0 is return More... | |
bool | getBool (std::string attName) const |
field accessor: get the field attName as a bool value, if field does not exist, false is return More... | |
std::string | getString (std::string attName) const |
field accessor: get the field attName as a string value, if field does not exist, empty string is return More... | |
void | get (std::string attName, std::string &attVal) const |
field accessor: get the field attName as a string value in attVal, if field does not exist, empty string is return More... | |
void | set (std::string attName, double val) |
field modificator: set field attName using a double value More... | |
void | set (std::string attName, int val) |
field modificator: set field attName using an int value More... | |
void | set (std::string attName, bool val) |
field modificator: set field attName using a bool value More... | |
void | set (std::string attName, std::string val) |
field modificator: set field attName using a string value More... | |
Protected Member Functions | |
void | beginXML (std::ostream &) |
write the default xml properties (beginning) More... | |
void | endXML (std::ostream &) |
write the default xml properties (end) More... | |
Private Member Functions | |
void | alloc () |
Private Attributes | |
Color | color |
double * | colorRGBA |
RenderingMode | mode |
Additional Inherited Members | |
![]() | |
std::map< std::string, std::string > | fields |
map containing all the different fields (name, value stored as string ) More... | |
A special class to manage the basic structural component properties.
You should derive from this class a StucturalComponentProperties class and use it to implement your own custom stuff. This is a pure virtual class.
|
inline |
use a Color constant to set the color
References alloc(), setColor(), setMode(), and RenderingMode::WIREFRAME_AND_SURFACE.
BasicSCProperties::BasicSCProperties | ( | PhysicalModel * | p, |
xmlNodePtr | node | ||
) |
|
inline |
References alloc(), setColor(), setMode(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
use a double[3] array to set the color
References alloc(), setAlpha(), setMode(), setRGB(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
References alloc(), setAlpha(), setMode(), setRGB(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
use 3 floats to set the color
References alloc(), setAlpha(), setMode(), setRGB(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
References alloc(), setAlpha(), setMode(), setRGB(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
defaultcolor is gray
References alloc(), DEFAULT, setColor(), setMode(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inline |
References alloc(), DEFAULT, setColor(), setMode(), and RenderingMode::WIREFRAME_AND_SURFACE.
|
inlinevirtual |
References colorRGBA.
|
inlineprivate |
References colorRGBA.
Referenced by BasicSCProperties().
|
inlineprotected |
write the default xml properties (beginning)
References RenderingMode::getMode(), RenderingMode::getModeString(), Properties::getName(), mode, and RenderingMode::NONE.
|
inlineprotected |
write the default xml properties (end)
|
inline |
References colorRGBA.
|
inline |
References colorRGBA.
|
inline |
References color.
|
inline |
References colorRGBA.
|
inline |
References RenderingMode::getMode(), and mode.
|
inline |
get the string equivalent to the enum rendering mode
References RenderingMode::getModeString(), and mode.
|
inline |
References colorRGBA.
|
inline |
References colorRGBA.
|
inline |
References colorRGBA.
|
inline |
References RenderingMode::isVisible(), and mode.
|
inline |
References color, colorRGBA, and OTHER.
Referenced by BasicSCProperties(), and setRGBA().
|
inline |
|
inline |
|
inline |
|
inline |
References mode, and RenderingMode::setMode().
Referenced by BasicSCProperties().
|
inline |
|
inline |
Referenced by BasicSCProperties().
|
inline |
References color, OTHER, setBlue(), setGreen(), and setRed().
|
inline |
References color, OTHER, setAlpha(), setBlue(), setGreen(), and setRed().
Referenced by setColor(), and setRGBA().
|
inline |
|
inline |
References mode, and RenderingMode::setVisible().
|
pure virtual |
print to an output stream in "pseaudo" XML format.
This method is to be implemented in the subclass (StructuralComponentProperties). It HAS to call the beginXML() at the beginning and the endXML() at the end.
Implemented in StructuralComponentProperties.
|
private |
Referenced by getColor(), setAlpha(), setBlue(), setColor(), setGreen(), setRed(), setRGB(), and setRGBA().
|
private |
Referenced by alloc(), getAlpha(), getBlue(), getGreen(), getRed(), getRGB(), getRGBA(), setAlpha(), setBlue(), setGreen(), setRed(), and ~BasicSCProperties().
|
private |
Referenced by beginXML(), getMode(), getModeString(), isVisible(), setMode(), and setVisible().