image display properties More...

#include <vtkImageProperty.h>

Inheritance diagram for vtkImageProperty:

Collaboration diagram for vtkImageProperty:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	DeepCopy (vtkImageProperty *p)
unsigned long	GetMTime ()

virtual void	SetColorWindow (double)
virtual double	GetColorWindow ()

virtual void	SetColorLevel (double)
virtual double	GetColorLevel ()

virtual void	SetLookupTable (vtkScalarsToColors *lut)
virtual vtkScalarsToColors *	GetLookupTable ()

virtual void	SetUseLookupTableScalarRange (int)
virtual int	GetUseLookupTableScalarRange ()
virtual void	UseLookupTableScalarRangeOn ()
virtual void	UseLookupTableScalarRangeOff ()

virtual void	SetOpacity (double)
virtual double	GetOpacity ()

virtual void	SetAmbient (double)
virtual double	GetAmbient ()

virtual void	SetDiffuse (double)
virtual double	GetDiffuse ()

virtual void	SetInterpolationType (int)
virtual int	GetInterpolationType ()
void	SetInterpolationTypeToNearest ()
void	SetInterpolationTypeToLinear ()
void	SetInterpolationTypeToCubic ()
virtual const char *	GetInterpolationTypeAsString ()

virtual void	SetLayerNumber (int)
int	GetLayerNumber ()

virtual void	SetCheckerboard (int)
virtual void	CheckerboardOn ()
virtual void	CheckerboardOff ()
virtual int	GetCheckerboard ()

virtual void	SetCheckerboardSpacing (double, double)
void	SetCheckerboardSpacing (double[2])
virtual double *	GetCheckerboardSpacing ()
virtual void	GetCheckerboardSpacing (double &, double &)
virtual void	GetCheckerboardSpacing (double[2])

virtual void	SetCheckerboardOffset (double, double)
void	SetCheckerboardOffset (double[2])
virtual double *	GetCheckerboardOffset ()
virtual void	GetCheckerboardOffset (double &, double &)
virtual void	GetCheckerboardOffset (double[2])

virtual void	SetBacking (int)
virtual void	BackingOn ()
virtual void	BackingOff ()
virtual int	GetBacking ()

virtual void	SetBackingColor (double, double, double)
virtual void	SetBackingColor (double[3])
virtual double *	GetBackingColor ()
virtual void	GetBackingColor (double &, double &, double &)
virtual void	GetBackingColor (double[3])
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkImageProperty *	SafeDownCast (vtkObjectBase *o)
static vtkImageProperty *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageProperty ()
	~vtkImageProperty ()
Protected Attributes
vtkScalarsToColors *	LookupTable
double	ColorWindow
double	ColorLevel
int	UseLookupTableScalarRange
int	InterpolationType
int	LayerNumber
double	Opacity
double	Ambient
double	Diffuse
int	Checkerboard
double	CheckerboardSpacing [2]
double	CheckerboardOffset [2]
int	Backing
double	BackingColor [3]

Detailed Description

image display properties

vtkImageProperty is an object that allows control of the display of an image slice.

Thanks:: Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.

See also:: vtkImage vtkImageMapper3D vtkImageSliceMapper vtkImageResliceMapper

Examples:: vtkImageProperty (Examples)

Tests:: vtkImageProperty (Tests)

Definition at line 41 of file vtkImageProperty.h.

Member Typedef Documentation

typedef vtkObject vtkImageProperty::Superclass

Reimplemented from vtkObject.

Definition at line 44 of file vtkImageProperty.h.

Constructor & Destructor Documentation

vtkImageProperty::vtkImageProperty ( ) [protected]

vtkImageProperty::~vtkImageProperty ( ) [protected]

Member Function Documentation

static int vtkImageProperty::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkImageProperty::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkImageProperty* vtkImageProperty::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkImageProperty::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkImageProperty* vtkImageProperty::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkImageProperty::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkImageProperty* vtkImageProperty::New ( ) [static]

Construct a property with no lookup table.

Reimplemented from vtkObject.

void vtkImageProperty::DeepCopy ( vtkImageProperty * p )

Assign one property to another.

virtual void vtkImageProperty::SetColorWindow ( double ) [virtual]

The window value for window/level.

virtual double vtkImageProperty::GetColorWindow ( ) [virtual]

The window value for window/level.

virtual void vtkImageProperty::SetColorLevel ( double ) [virtual]

The level value for window/level.

virtual double vtkImageProperty::GetColorLevel ( ) [virtual]

The level value for window/level.

virtual void vtkImageProperty::SetLookupTable ( vtkScalarsToColors * lut ) [virtual]

Specify a lookup table for the data. If the data is to be displayed as greyscale, or if the input data is already RGB, there is no need to set a lookup table.

virtual vtkScalarsToColors* vtkImageProperty::GetLookupTable ( ) [virtual]

Specify a lookup table for the data. If the data is to be displayed as greyscale, or if the input data is already RGB, there is no need to set a lookup table.

virtual void vtkImageProperty::SetUseLookupTableScalarRange ( int ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual int vtkImageProperty::GetUseLookupTableScalarRange ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::UseLookupTableScalarRangeOn ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::UseLookupTableScalarRangeOff ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::SetOpacity ( double ) [virtual]

The opacity of the image, where 1.0 is opaque and 0.0 is transparent. If the image has an alpha component, then the alpha component will be multiplied by this value.

virtual double vtkImageProperty::GetOpacity ( ) [virtual]

The opacity of the image, where 1.0 is opaque and 0.0 is transparent. If the image has an alpha component, then the alpha component will be multiplied by this value.

virtual void vtkImageProperty::SetAmbient ( double ) [virtual]

The ambient lighting coefficient. The default is 1.0.

virtual double vtkImageProperty::GetAmbient ( ) [virtual]

The ambient lighting coefficient. The default is 1.0.

virtual void vtkImageProperty::SetDiffuse ( double ) [virtual]

The diffuse lighting coefficient. The default is 0.0.

virtual double vtkImageProperty::GetDiffuse ( ) [virtual]

The diffuse lighting coefficient. The default is 0.0.

virtual void vtkImageProperty::SetInterpolationType ( int ) [virtual]