Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkSlicerScalarBarActor Class Reference

#include <Modules/Loadable/Colors/VTKWidgets/vtkSlicerScalarBarActor.h>

Inheritance diagram for vtkSlicerScalarBarActor:
Collaboration diagram for vtkSlicerScalarBarActor:

Public Types

typedef vtkScalarBarActor Superclass
 

Public Member Functions

virtual void CenterLabelOff ()
 
virtual void CenterLabelOn ()
 
virtual bool GetCenterLabel ()
 
virtual const char * GetClassName ()
 
virtual int GetUseAnnotationAsLabel ()
 Get for the flag on using VTK6 annotation as label.
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetCenterLabel (bool)
 
virtual void SetUseAnnotationAsLabel (int)
 Set for the flag on using VTK6 annotation as label.
 
virtual void UseAnnotationAsLabelOff ()
 
virtual void UseAnnotationAsLabelOn ()
 Get/Set for the flag on using VTK6 annotation as label.
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSlicerScalarBarActorNew ()
 
static vtkSlicerScalarBarActorSafeDownCast (vtkObject *o)
 

Protected Member Functions

void ConfigureTicks () override
 
void ConfigureTitle () override
 
void LayoutTicks () override
 
void PrepareTitleText () override
 
 vtkSlicerScalarBarActor ()
 
 ~vtkSlicerScalarBarActor () override
 

Static Protected Member Functions

static bool ValidateFormatString (std::string &validatedFormat, std::string &prefix, std::string &suffix, const std::string &requestedFormat, const std::string &typeString)
 

Protected Attributes

bool CenterLabel
 
int UseAnnotationAsLabel
 flag for setting color name as label
 

Detailed Description

vtkSlicerScalarBarActor - slicer vtk class for adding color names in scalar bar

This class enhances the vtkScalarBarActor class by adding color names in the label display.

Definition at line 39 of file vtkSlicerScalarBarActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkScalarBarActor vtkSlicerScalarBarActor::Superclass

Definition at line 45 of file vtkSlicerScalarBarActor.h.

Constructor & Destructor Documentation

◆ vtkSlicerScalarBarActor()

vtkSlicerScalarBarActor::vtkSlicerScalarBarActor ( )
protected

◆ ~vtkSlicerScalarBarActor()

vtkSlicerScalarBarActor::~vtkSlicerScalarBarActor ( )
overrideprotected

Member Function Documentation

◆ CenterLabelOff()

virtual void vtkSlicerScalarBarActor::CenterLabelOff ( )
virtual

◆ CenterLabelOn()

virtual void vtkSlicerScalarBarActor::CenterLabelOn ( )
virtual

Get/Set if label should be centered on color swatches. Useful if each displayed color needs a label

◆ ConfigureTicks()

void vtkSlicerScalarBarActor::ConfigureTicks ( )
overrideprotected

◆ ConfigureTitle()

void vtkSlicerScalarBarActor::ConfigureTitle ( )
overrideprotected

◆ GetCenterLabel()

virtual bool vtkSlicerScalarBarActor::GetCenterLabel ( )
virtual

Get if label should be centered on color swatches. Useful if each displayed color needs a label

◆ GetClassName()

virtual const char * vtkSlicerScalarBarActor::GetClassName ( )
virtual

◆ GetUseAnnotationAsLabel()

virtual int vtkSlicerScalarBarActor::GetUseAnnotationAsLabel ( )
virtual

Get for the flag on using VTK6 annotation as label.

◆ IsA()

virtual int vtkSlicerScalarBarActor::IsA ( const char * type)
virtual

◆ IsTypeOf()

static int vtkSlicerScalarBarActor::IsTypeOf ( const char * type)
static

◆ LayoutTicks()

void vtkSlicerScalarBarActor::LayoutTicks ( )
overrideprotected

◆ New()

static vtkSlicerScalarBarActor * vtkSlicerScalarBarActor::New ( )
static

◆ PrepareTitleText()

void vtkSlicerScalarBarActor::PrepareTitleText ( )
overrideprotected

◆ PrintSelf()

void vtkSlicerScalarBarActor::PrintSelf ( ostream & os,
vtkIndent indent )
override

◆ SafeDownCast()

static vtkSlicerScalarBarActor * vtkSlicerScalarBarActor::SafeDownCast ( vtkObject * o)
static

◆ SetCenterLabel()

virtual void vtkSlicerScalarBarActor::SetCenterLabel ( bool )
virtual

Set if label should be centered on color swatches. Useful if each displayed color needs a label

◆ SetUseAnnotationAsLabel()

virtual void vtkSlicerScalarBarActor::SetUseAnnotationAsLabel ( int )
virtual

Set for the flag on using VTK6 annotation as label.

◆ UseAnnotationAsLabelOff()

virtual void vtkSlicerScalarBarActor::UseAnnotationAsLabelOff ( )
virtual

◆ UseAnnotationAsLabelOn()

virtual void vtkSlicerScalarBarActor::UseAnnotationAsLabelOn ( )
virtual

Get/Set for the flag on using VTK6 annotation as label.

◆ ValidateFormatString()

static bool vtkSlicerScalarBarActor::ValidateFormatString ( std::string & validatedFormat,
std::string & prefix,
std::string & suffix,
const std::string & requestedFormat,
const std::string & typeString )
staticprotected

Parses the requestedFormat string to find a validated format for the types contained in typeString. validatedFormat is set to the first matching sprintf for the input types prefix and suffix are set to the non-matching components of requestedFormat

Member Data Documentation

◆ CenterLabel

bool vtkSlicerScalarBarActor::CenterLabel
protected

Definition at line 100 of file vtkSlicerScalarBarActor.h.

◆ UseAnnotationAsLabel

int vtkSlicerScalarBarActor::UseAnnotationAsLabel
protected

flag for setting color name as label

Definition at line 98 of file vtkSlicerScalarBarActor.h.


The documentation for this class was generated from the following file: