IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Gr3d::VtkDecorationHandler Class Reference

Manipulates axes, labels, grids, and other decorations of graphhics plotted in VTK windows. More...

Inheritance diagram for IG::Gr3d::VtkDecorationHandler:
Collaboration diagram for IG::Gr3d::VtkDecorationHandler:

List of all members.

Public Member Functions

 VtkDecorationHandler (VtkPlotter plotter)
 Constructor. Since no Actors or Renderers are specified, updating the containing bounding box will take into account all Actors of all Renderers that are currently attached to the window.
 VtkDecorationHandler (VtkPlotter plotter, bool updateImmediately)
 Constructor. Since no Actors or Renderers are specified, updating the containing bounding box will take into account all Actors of all Renderers that are currently attached to the window.
 VtkDecorationHandler (VtkPlotter plotter, params vtkActor[] actors)
 Constructor. Updating the containing bounding box will take into account all specified Actors.
 VtkDecorationHandler (VtkPlotter plotter, bool updateImmediately, params vtkActor[] actors)
 Constructor. Updating the containing bounding box will take into account all specified Actors.
 VtkDecorationHandler (VtkPlotter plotter, params vtkRenderer[] renderers)
 Constructor. Updating the containing bounding box will take into account all specified Renderers.
 VtkDecorationHandler (VtkPlotter plotter, bool updateImmediately, params vtkRenderer[] renderers)
 Constructor. Updating the containing bounding box will take into account all specified Renderers.
 VtkDecorationHandler (VtkPlotter plotter, vtkRenderer renderer, params vtkActor[] actors)
 Constructor. Updating the containing bounding box will take into account all specified Actors.
void ChangeWindow (vtkRenderWindow win)
 Changes the VTK render window of the current decoration handler.
void AddActors (params vtkActor[] actors)
 Adds the specified rendereds to the list of actors that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.
void RemoveActors (params vtkActor[] actors)
 Removes the specified actors from the list of actors for which axes and other decorations are handled. If some actor is included in the list multiple times then it is removed until it is no longer contained.
void AddActors2D (params vtkActor2D[] actors2D)
 Adds the specified rendereds to the list of actors2D that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.
void RemoveActors2D (params vtkActor2D[] actors2D)
 Removes the specified actors2D from the list of actors2D for which axes and other decorations are handled. If some actor is included in the list multiple times then it is removed until it is no longer contained.
void AddRenderers (params vtkRenderer[] renderers)
 Adds the specified rendereds to the list of renderers that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.
void RemoveRenderers (params vtkRenderer[] renderers)
 Removes the specified renderers from the list of renderers for which axes and other decorations are handled. If some renderer is included in the list multiple times then it is removed until it is no longer contained.
void ResetBounds ()
 Resets the bounds.
void SetBounds ()
 Sets the bounds for actors that to eventual internal bounds.
void SetBounds (IBoundingBox bounds)
 Sets the bounds for actors that must fill the bounding box aroung all graphic objects, to the specifid values.
void SetCubeAxesLabels (string xLabel, string yLable, string zLabel)
void SetActorScale (double X, double Y, double Z)
void AddActorsToPlotter ()
 Adds all actors from the current decoration handler to the plotter that it is assigned to.
void AddActorsToPlotter (VtkPlotter plotter)
 Adds all actors from the current plot to the specified plotter.
void AddActorsToRenderer ()
 Adds all actors from the current decoraton handler to its current renderer.
void AddActorsToRenderer (vtkRenderer renderer)
 Adds all actors from the current decoration handler to the specified rendeerr.
virtual void Update ()
 Updates decorations.

Static Public Member Functions

static void SetCubeAxesActorBounds (vtkCubeAxesActor actor, IBoundingBox newBounds)
 Sets position and sizing of the specified cube axes actor according to the specified bounds.

Protected Member Functions

bool IsHandlersInternal (vtkActor actor)
 Returns true if the specified actor is internal (auxiliary) actor of the current object, false otherwise. In such a case the actor will not take part in some operations, e.g. in determining the bounding box of the graphic scene.
bool IsHandlersInternal (vtkRenderer renderer)
 Returns true if the specified renderer is internal (auxiliary) renderer of the current object, false otherwise. In such a case the renderer will not take part in some operations, e.g. in determining the bounding box of the graphic scene.
void UpdateBounds ()
 Updates the bounds according to eventual internal bounds (defined by actors and renderers included in the current decorator). This also updates positioning and sizing of included decorations such that cube axes.
void UpdateBounds (IBoundingBox bounds)
 Updates the bounds according to eventual internal bounds (defined by actors and renderers included in the current decorator), and additionally also according to the specified bounds. This also updates positioning and sizing of included decorations such that cube axes.
void UpdateBoundsInternal ()
 Updates the bounding box Bounds in such a way that it contains all actors from the internal list of actors and all renderers from the internal list of renderers.

Protected Attributes

VtkPlotter _plotter
vtkRenderer _decorationRenderer
vtkCubeAxesActor _cubeAxesActor

Properties

object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock.
VtkPlotter Plotter [get, set]
VtkPlotter.Accessor PlotterAccessor [get, set]
 Accessor object that grants access to some protected fields and properties of the VTK plotter (property Plotter).
vtkRenderWindow Window [get, set]
 VTK window in which plotting is performed.
List< vtkActor > Actors [get]
 A list of Actors that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.
List< vtkActor2D > Actors2D [get]
 A list of Actors2D that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.
List< vtkRenderer > Renderers [get]
 A list of Renderers that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.
bool IsBoundsUpdated [get, set]
 Whether bounds are updated or not, according to internal actors and renderers.
IBoundingBox Bounds [get, set]
 Bounds of the graphic scene for which axes and other decorations are handled.
vtkRenderer DecorationRenderer [get, set]
 Gets the renderer used for decoration entities (axes, etc.). Currently, no special renderer is created for tgis purpose, but one is obtained either from the list of renderers included in the 3D graphics scene, or one is obtained form the VTK window attached to this object. Lazy evaluation. Renderer is obtained only when first needed.
vtkLegendBoxActor LegendBoxActor [get, set]
bool ShowLegendBox [get, set]
 Whether legend-box is shown or not. Default is false.
int LegendBoxNumEntries [get, set]
 Number of labels in legend-box. Default 1.
string[] LegendBoxTitles [get, set]
 A table of Titles for LegendBox Default is "Title 1".
vtkPolyData Symbol [get, set]
 A table of symbols for LegendBox Default is "Sphere symbol".
vtkScalarBarActor ScalarBarActor [get, set]
vtkLookupTable ScalarBarLookupTable [get, set]
ColorScale LookUpTableColorScale [get, set]
 Color scale for lookuptable. Default is rainbow.
int LookUpTableNumTableValues [get, set]
 Number of table values. Default is 100.
double LookUpTableAlpha [get, set]
 Alpha value for lookuptable. Default is 1.
double LookUpTableMinHue [get, set]
 Minimum hue value for lookuptable. Default is 0.
double LookUpTableMaxHue [get, set]
 Minimum hue value for lookuptable. Default is 1.
double LookUpTableMinSaturation [get, set]
 Minimum saturation value for lookuptable. Default is 0.
double LookUpTableMaxSaturation [get, set]
 Maximum saturation value for lookuptable. Default is 1.
double LookUpTableMinValue [get, set]
 Minimum value for lookuptable. Default is 0.
double LookUpTableMaxValue [get, set]
 Maximum value for lookuptable. Default is 1.
double LookUpTableMinRange [get, set]
 Minimum range for lookuptable. Default is 0.
double LookUpTableMaxRange [get, set]
 Maximum range for lookuptable. Default is 1.
int LookUpTableNumColors [get, set]
 Number fo collors in lookuptable. Default is 100.
bool ShowScalarBar [get, set]
 Whether scalar-bar is shown or not. Default is true.
string ScalarBarTitle [get, set]
 Title for scalar bar.
int ScalarBarNumberOfLabels [get, set]
 Numer of labels on the scalar bar.
int ScalarBarOrientation [get, set]
 Orientation of the scalar bar. 0 - Horizontal; 1 - Vertical.
double ScalarBarXPosition [get, set]
 Position X of the scalar bar.
double ScalarBarYPosition [get, set]
 Position Y of the scalar bar.
double ScalarBarHeight [get, set]
 Hight of the scalar bar.
double ScalarBarWidth [get, set]
 Width of the scalar bar.
vtkCubeAxesActor CubeAxesActor [get, set]
 Actor that is used for manipulating cube axes. Warning:The returned actor can eventually be used to set properties of the axes that are not supported by the current handler object. However, it is recommended to avoid such use whenever possible because such properties may be overridden unpredictedly by the current helper object.
vtkProperty CubeAxesProperties [get]
 Gets the Axes' properties, through wihich the caller can set additional properties that are not enabled by the current helper object. Warning:Use this only exceptionally. Changes made on the returned object may be overridden unpredictedly by the current helper object.
string CubeAxesXLabel [get, set]
 Label for X axis.
string CubeAxesYLabel [get, set]
 Label for Y axis.
string CubeAxesZLabel [get, set]
 Label for Z axis.
VtkFlyMode CubeAxesFlyMode [get, set]
 Positioning mode ("fly mode") of the axes. Default is VtkFlyMode.Static.
bool ShowCubeAxes [get, set]
 Whether axes are shown or not. Default is true.
color CubeAxesColor [get, set]
 Gets or sets axes color.
double CubeAxesWidth [get, set]
 Gets or sets width of the axes lines.
bool UpdateWhenConstructed [get, set]
 Whether decorations to be drawn are added to the VTK window's renderer immediately after the current decoration handler object is constructed.

Private Member Functions

 VtkDecorationHandler ()

Private Attributes

 null
VtkPlotter.Accessor _plotterAccessor
IBoundingBox _bounds
vtkRenderWindow _window
List< vtkActor > _actors = new List<vtkActor>()
List< vtkActor2D > _actors2D = new List<vtkActor2D>()
List< vtkRenderer > _renderers = new List<vtkRenderer>()
bool _isBoundsUpdated = false
vtkLegendBoxActor _legendBoxActor
bool _showLegendBox = false
int _legendBoxNumEntries = 1
string[] _legendBoxTitles = new string [1] {"Title 1"}
vtkPolyData _symbol
vtkScalarBarActor _scalarBarActor
vtkLookupTable _scalarBarLookupTable
ColorScale _lookUpTableColorScale
int _lookUpTableNumTableValues = 100
double _lookUpTableAlpha = 1
double _lookUpTableMinHue = 0
double _lookUpTableMaxHue = 1
double _lookUpTableMinSaturation = 0
double _lookUpTableMaxSaturation = 1
double _lookUpTableMinValue
double _lookUpTableMaxValue
double _lookUpTableMinRange
double _lookUpTableMaxRange
int _lookupTableNumColors = 100
bool _showSclarBar = false
string _scalarBarTitle = "Values"
int _scalarBarNumberOfLabels
int _scalarBarOrientation
double _scalarBarXPosition = 0.25
double _scalarBarYPosition = 0.01
double _scalarBarHeight = 0.1
double _scalarBarWidth = 0.5
string _cubeAxesXLabel
string _cubeAxesYLabel
string _cubeAxesZLabel
double _actorXScale
double _actorYScale
double _actorZScale
VtkFlyMode _cubeAxesFlyMode = VtkFlyMode.Static
bool _showCubeAxes = true
color _cubeAxesColor = new color(System.Drawing.Color.Gray)
double _cubeAxesWidth = 1
bool _updateWhenConstructed = true

Static Private Attributes

static double min = 0
static double max = 1

Detailed Description

Manipulates axes, labels, grids, and other decorations of graphhics plotted in VTK windows.

Currently, all the decorations are put on a single renderer that is one of the renderers that are already used. Initially the idea is that a separate renderer would be used for axes and other decorations generated and handled by this class. Since we don't currently know how one can combine multiple renderers in the same window and show contents of all of them together with the same viewing projection (is this possible at all?), we use the first renderer that is provided. $A Igor Oct11;


Constructor & Destructor Documentation

IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( ) [inline, private]
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter) [inline]

Constructor. Since no Actors or Renderers are specified, updating the containing bounding box will take into account all Actors of all Renderers that are currently attached to the window.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
bool  updateImmediately 
) [inline]

Constructor. Since no Actors or Renderers are specified, updating the containing bounding box will take into account all Actors of all Renderers that are currently attached to the window.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
updateImmediatelyWhether decorations are updated immediately when constructed. If false then Update() must be called if one wants decorations to be displayed.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
params vtkActor[]  actors 
) [inline]

Constructor. Updating the containing bounding box will take into account all specified Actors.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
actorsA list of Actors that are a part of the graphic scene for which axes and other decorations are handled.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
bool  updateImmediately,
params vtkActor[]  actors 
) [inline]

Constructor. Updating the containing bounding box will take into account all specified Actors.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
updateImmediatelyWhether decorations are updated immediately when constructed. If false then Update() must be called if one wants decorations to be displayed.
actorsA list of Actors that are a part of the graphic scene for which axes and other decorations are handled.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
params vtkRenderer[]  renderers 
) [inline]

Constructor. Updating the containing bounding box will take into account all specified Renderers.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
renderersA list of Renderers that are a part of the graphic scene for which axes and other decorations are handled.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
bool  updateImmediately,
params vtkRenderer[]  renderers 
) [inline]

Constructor. Updating the containing bounding box will take into account all specified Renderers.

Parameters:
updateImmediatelyWhether decorations are updated immediately when constructed. If false then Update() must be called if one wants decorations to be displayed.
plotterVTK plotter for which axes and other decoration entities are manipulated.
renderersA list of Renderers that are a part of the graphic scene for which axes and other decorations are handled.
IG::Gr3d::VtkDecorationHandler::VtkDecorationHandler ( VtkPlotter  plotter,
vtkRenderer  renderer,
params vtkActor[]  actors 
) [inline]

Constructor. Updating the containing bounding box will take into account all specified Actors.

Parameters:
plotterVTK plotter for which axes and other decoration entities are manipulated.
renderersA (single) renderer that is a part of the graphic scene for which axes and other decorations are handled.
actorsA list of Actors that are a part of the graphic scene for which axes and other decorations are handled.

Member Function Documentation

void IG::Gr3d::VtkDecorationHandler::ChangeWindow ( vtkRenderWindow  win) [inline]

Changes the VTK render window of the current decoration handler.

Parameters:
winWindow that becomes this object's new rendering window.
void IG::Gr3d::VtkDecorationHandler::AddActors ( params vtkActor[]  actors) [inline]

Adds the specified rendereds to the list of actors that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.

Parameters:
actorsActors to be added to the list.
void IG::Gr3d::VtkDecorationHandler::RemoveActors ( params vtkActor[]  actors) [inline]

Removes the specified actors from the list of actors for which axes and other decorations are handled. If some actor is included in the list multiple times then it is removed until it is no longer contained.

Parameters:
actorsActors to be removed from the list.
bool IG::Gr3d::VtkDecorationHandler::IsHandlersInternal ( vtkActor  actor) [inline, protected]

Returns true if the specified actor is internal (auxiliary) actor of the current object, false otherwise. In such a case the actor will not take part in some operations, e.g. in determining the bounding box of the graphic scene.

Parameters:
actorActor for which we querry whether it is an internal actor of the current helper object.
void IG::Gr3d::VtkDecorationHandler::AddActors2D ( params vtkActor2D[]  actors2D) [inline]

Adds the specified rendereds to the list of actors2D that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.

Parameters:
actorsActors2D to be added to the list.

$A Igor Oct11, Tako78 Dec13;

void IG::Gr3d::VtkDecorationHandler::RemoveActors2D ( params vtkActor2D[]  actors2D) [inline]

Removes the specified actors2D from the list of actors2D for which axes and other decorations are handled. If some actor is included in the list multiple times then it is removed until it is no longer contained.

Parameters:
actorsActors2D to be removed from the list.

$A Igor Oct11, Tako78 Dec13;

void IG::Gr3d::VtkDecorationHandler::AddRenderers ( params vtkRenderer[]  renderers) [inline]

Adds the specified rendereds to the list of renderers that are contained in the scene for which axes and other decoration entities are manipulated. Uniqueness is not guaranteed, i.e. the same actor can be added several times.

Parameters:
renderersRenderers that are added to the list.
void IG::Gr3d::VtkDecorationHandler::RemoveRenderers ( params vtkRenderer[]  renderers) [inline]

Removes the specified renderers from the list of renderers for which axes and other decorations are handled. If some renderer is included in the list multiple times then it is removed until it is no longer contained.

Parameters:
renderersRendeerrs to be removed from the list.
bool IG::Gr3d::VtkDecorationHandler::IsHandlersInternal ( vtkRenderer  renderer) [inline, protected]

Returns true if the specified renderer is internal (auxiliary) renderer of the current object, false otherwise. In such a case the renderer will not take part in some operations, e.g. in determining the bounding box of the graphic scene.

Parameters:
rendererRenderer for which we querry whether it is an internal renderer of the current helper object.
void IG::Gr3d::VtkDecorationHandler::ResetBounds ( ) [inline]

Resets the bounds.

void IG::Gr3d::VtkDecorationHandler::UpdateBounds ( ) [inline, protected]

Updates the bounds according to eventual internal bounds (defined by actors and renderers included in the current decorator). This also updates positioning and sizing of included decorations such that cube axes.

void IG::Gr3d::VtkDecorationHandler::UpdateBounds ( IBoundingBox  bounds) [inline, protected]

Updates the bounds according to eventual internal bounds (defined by actors and renderers included in the current decorator), and additionally also according to the specified bounds. This also updates positioning and sizing of included decorations such that cube axes.

Parameters:
boundsSpecified bounds according to which the bounds are also decorated (beside the internal bounds).
void IG::Gr3d::VtkDecorationHandler::SetBounds ( ) [inline]

Sets the bounds for actors that to eventual internal bounds.

Parameters:
boundsBounding box to which the bounds are set.
void IG::Gr3d::VtkDecorationHandler::SetBounds ( IBoundingBox  bounds) [inline]

Sets the bounds for actors that must fill the bounding box aroung all graphic objects, to the specifid values.

Parameters:
boundsBounding box to which the bounds are set.
static void IG::Gr3d::VtkDecorationHandler::SetCubeAxesActorBounds ( vtkCubeAxesActor  actor,
IBoundingBox  newBounds 
) [inline, static]

Sets position and sizing of the specified cube axes actor according to the specified bounds.

Parameters:
actorActor whose bounds are updated.
newBoundsNew bounds of the actor.
void IG::Gr3d::VtkDecorationHandler::UpdateBoundsInternal ( ) [inline, protected]

Updates the bounding box Bounds in such a way that it contains all actors from the internal list of actors and all renderers from the internal list of renderers.

void IG::Gr3d::VtkDecorationHandler::SetCubeAxesLabels ( string  xLabel,
string  yLable,
string  zLabel 
) [inline]
void IG::Gr3d::VtkDecorationHandler::SetActorScale ( double  X,
double  Y,
double  Z 
) [inline]
void IG::Gr3d::VtkDecorationHandler::AddActorsToPlotter ( ) [inline]

Adds all actors from the current decoration handler to the plotter that it is assigned to.

void IG::Gr3d::VtkDecorationHandler::AddActorsToPlotter ( VtkPlotter  plotter) [inline]

Adds all actors from the current plot to the specified plotter.

Parameters:
plotterPlotter to which actors from the current plot are added.
void IG::Gr3d::VtkDecorationHandler::AddActorsToRenderer ( ) [inline]

Adds all actors from the current decoraton handler to its current renderer.

void IG::Gr3d::VtkDecorationHandler::AddActorsToRenderer ( vtkRenderer  renderer) [inline]

Adds all actors from the current decoration handler to the specified rendeerr.

Parameters:
rendererVTK renderer to which actors from the current plot are added.
virtual void IG::Gr3d::VtkDecorationHandler::Update ( ) [inline, virtual]

Updates decorations.


Member Data Documentation

vtkRenderWindow IG::Gr3d::VtkDecorationHandler::_window [private]
List<vtkActor> IG::Gr3d::VtkDecorationHandler::_actors = new List<vtkActor>() [private]
List<vtkActor2D> IG::Gr3d::VtkDecorationHandler::_actors2D = new List<vtkActor2D>() [private]
List<vtkRenderer> IG::Gr3d::VtkDecorationHandler::_renderers = new List<vtkRenderer>() [private]
string [] IG::Gr3d::VtkDecorationHandler::_legendBoxTitles = new string [1] {"Title 1"} [private]
double IG::Gr3d::VtkDecorationHandler::min = 0 [static, private]
double IG::Gr3d::VtkDecorationHandler::max = 1 [static, private]
vtkCubeAxesActor IG::Gr3d::VtkDecorationHandler::_cubeAxesActor [protected]
color IG::Gr3d::VtkDecorationHandler::_cubeAxesColor = new color(System.Drawing.Color.Gray) [private]

Property Documentation

object IG::Gr3d::VtkDecorationHandler::Lock [get]

This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock.

Implements IG::Lib::ILockable.

VtkPlotter IG::Gr3d::VtkDecorationHandler::Plotter [get, set]
VtkPlotter.Accessor IG::Gr3d::VtkDecorationHandler::PlotterAccessor [get, set, protected]

Accessor object that grants access to some protected fields and properties of the VTK plotter (property Plotter).

vtkRenderWindow IG::Gr3d::VtkDecorationHandler::Window [get, set]

VTK window in which plotting is performed.

List<vtkActor> IG::Gr3d::VtkDecorationHandler::Actors [get, protected]

A list of Actors that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.

List<vtkActor2D> IG::Gr3d::VtkDecorationHandler::Actors2D [get, protected]

A list of Actors2D that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.

$A Igor Oct11, Tako78 Dec13;

List<vtkRenderer> IG::Gr3d::VtkDecorationHandler::Renderers [get, protected]

A list of Renderers that are a part of the graphic scene for which axes and other decorations are handled. Mainly used for updating the bounding box. WARNING: Whenever possible, this list should not be accessed directly. Use (create them, if necessary) other methods that perform specific operations on the lisr.

bool IG::Gr3d::VtkDecorationHandler::IsBoundsUpdated [get, set]

Whether bounds are updated or not, according to internal actors and renderers.

IBoundingBox IG::Gr3d::VtkDecorationHandler::Bounds [get, set, protected]

Bounds of the graphic scene for which axes and other decorations are handled.

vtkRenderer IG::Gr3d::VtkDecorationHandler::DecorationRenderer [get, set]

Gets the renderer used for decoration entities (axes, etc.). Currently, no special renderer is created for tgis purpose, but one is obtained either from the list of renderers included in the 3D graphics scene, or one is obtained form the VTK window attached to this object. Lazy evaluation. Renderer is obtained only when first needed.

vtkLegendBoxActor IG::Gr3d::VtkDecorationHandler::LegendBoxActor [get, set]
bool IG::Gr3d::VtkDecorationHandler::ShowLegendBox [get, set]

Whether legend-box is shown or not. Default is false.

$A Igor Oct11, Tako78 Dec23;

int IG::Gr3d::VtkDecorationHandler::LegendBoxNumEntries [get, set]

Number of labels in legend-box. Default 1.

$A Igor Oct11, Tako78 Dec23;

string [] IG::Gr3d::VtkDecorationHandler::LegendBoxTitles [get, set]

A table of Titles for LegendBox Default is "Title 1".

$A Igor Oct11, Tako78 Dec23;

vtkPolyData IG::Gr3d::VtkDecorationHandler::Symbol [get, set]

A table of symbols for LegendBox Default is "Sphere symbol".

$A Igor Oct11, Tako78 Dec23;

vtkScalarBarActor IG::Gr3d::VtkDecorationHandler::ScalarBarActor [get, set]
vtkLookupTable IG::Gr3d::VtkDecorationHandler::ScalarBarLookupTable [get, set]
ColorScale IG::Gr3d::VtkDecorationHandler::LookUpTableColorScale [get, set]

Color scale for lookuptable. Default is rainbow.

$A Igor Oct11, Tako78 Dec22;

int IG::Gr3d::VtkDecorationHandler::LookUpTableNumTableValues [get, set]

Number of table values. Default is 100.

$A Igor Oct11, Tako78 Dec22;

double IG::Gr3d::VtkDecorationHandler::LookUpTableAlpha [get, set]

Alpha value for lookuptable. Default is 1.

$A Igor Oct11, Tako78 Dec23;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMinHue [get, set]

Minimum hue value for lookuptable. Default is 0.

$A Igor Oct11, Tako78 Dec23;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMaxHue [get, set]

Minimum hue value for lookuptable. Default is 1.

$A Igor Oct11, Tako78 Dec23;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMinSaturation [get, set]

Minimum saturation value for lookuptable. Default is 0.

$A Igor Oct11, Tako78 Dec23;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMaxSaturation [get, set]

Maximum saturation value for lookuptable. Default is 1.

$A Igor Oct11, Tako78 Dec23;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMinValue [get, set]

Minimum value for lookuptable. Default is 0.

$A Igor Oct11, Tako78 Dec22;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMaxValue [get, set]

Maximum value for lookuptable. Default is 1.

$A Igor Oct11, Tako78 Dec22;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMinRange [get, set]

Minimum range for lookuptable. Default is 0.

$A Igor Oct11, Tako78 Dec22;

double IG::Gr3d::VtkDecorationHandler::LookUpTableMaxRange [get, set]

Maximum range for lookuptable. Default is 1.

$A Igor Oct11, Tako78 Dec22;

int IG::Gr3d::VtkDecorationHandler::LookUpTableNumColors [get, set]

Number fo collors in lookuptable. Default is 100.

$A Igor Oct11, Tako78 Dec22;

bool IG::Gr3d::VtkDecorationHandler::ShowScalarBar [get, set]

Whether scalar-bar is shown or not. Default is true.

$A Igor Oct11, Tako78 Dec13;

string IG::Gr3d::VtkDecorationHandler::ScalarBarTitle [get, set]

Title for scalar bar.

$A Igor Oct11, Tako78 Dec13;

int IG::Gr3d::VtkDecorationHandler::ScalarBarNumberOfLabels [get, set]

Numer of labels on the scalar bar.

$A Igor Oct11, Tako78 Dec13;

int IG::Gr3d::VtkDecorationHandler::ScalarBarOrientation [get, set]

Orientation of the scalar bar. 0 - Horizontal; 1 - Vertical.

$A Igor Oct11, Tako78 Dec13;

double IG::Gr3d::VtkDecorationHandler::ScalarBarXPosition [get, set]

Position X of the scalar bar.

$A Igor Oct11, Tako78 Dec14;

double IG::Gr3d::VtkDecorationHandler::ScalarBarYPosition [get, set]

Position Y of the scalar bar.

$A Igor Oct11, Tako78 Dec14;

double IG::Gr3d::VtkDecorationHandler::ScalarBarHeight [get, set]

Hight of the scalar bar.

$A Igor Oct11, Tako78 Dec13;

double IG::Gr3d::VtkDecorationHandler::ScalarBarWidth [get, set]

Width of the scalar bar.

$A Igor Oct11, Tako78 Dec13;

vtkCubeAxesActor IG::Gr3d::VtkDecorationHandler::CubeAxesActor [get, set]

Actor that is used for manipulating cube axes. Warning:The returned actor can eventually be used to set properties of the axes that are not supported by the current handler object. However, it is recommended to avoid such use whenever possible because such properties may be overridden unpredictedly by the current helper object.

vtkProperty IG::Gr3d::VtkDecorationHandler::CubeAxesProperties [get]

Gets the Axes' properties, through wihich the caller can set additional properties that are not enabled by the current helper object. Warning:Use this only exceptionally. Changes made on the returned object may be overridden unpredictedly by the current helper object.

string IG::Gr3d::VtkDecorationHandler::CubeAxesXLabel [get, set]

Label for X axis.

string IG::Gr3d::VtkDecorationHandler::CubeAxesYLabel [get, set]

Label for Y axis.

string IG::Gr3d::VtkDecorationHandler::CubeAxesZLabel [get, set]

Label for Z axis.

VtkFlyMode IG::Gr3d::VtkDecorationHandler::CubeAxesFlyMode [get, set]

Positioning mode ("fly mode") of the axes. Default is VtkFlyMode.Static.

bool IG::Gr3d::VtkDecorationHandler::ShowCubeAxes [get, set]

Whether axes are shown or not. Default is true.

color IG::Gr3d::VtkDecorationHandler::CubeAxesColor [get, set]

Gets or sets axes color.

double IG::Gr3d::VtkDecorationHandler::CubeAxesWidth [get, set]

Gets or sets width of the axes lines.

bool IG::Gr3d::VtkDecorationHandler::UpdateWhenConstructed [get, set]

Whether decorations to be drawn are added to the VTK window's renderer immediately after the current decoration handler object is constructed.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events