VTK
|
image display properties More...
#include <vtkImageProperty.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkImageProperty * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | DeepCopy (vtkImageProperty *p) |
Assign one property to another. More... | |
virtual void | SetColorWindow (double) |
The window value for window/level. More... | |
virtual double | GetColorWindow () |
virtual void | SetColorLevel (double) |
The level value for window/level. More... | |
virtual double | GetColorLevel () |
virtual void | SetLookupTable (vtkScalarsToColors *lut) |
Specify a lookup table for the data. More... | |
virtual vtkScalarsToColors * | GetLookupTable () |
virtual void | SetUseLookupTableScalarRange (vtkTypeBool) |
Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. More... | |
virtual vtkTypeBool | GetUseLookupTableScalarRange () |
virtual void | UseLookupTableScalarRangeOn () |
virtual void | UseLookupTableScalarRangeOff () |
virtual void | SetOpacity (double) |
The opacity of the image, where 1.0 is opaque and 0.0 is transparent. More... | |
virtual double | GetOpacity () |
virtual void | SetAmbient (double) |
The ambient lighting coefficient. More... | |
virtual double | GetAmbient () |
virtual void | SetDiffuse (double) |
The diffuse lighting coefficient. More... | |
virtual double | GetDiffuse () |
virtual void | SetInterpolationType (int) |
The interpolation type (default: nearest neighbor). More... | |
virtual int | GetInterpolationType () |
void | SetInterpolationTypeToNearest () |
void | SetInterpolationTypeToLinear () |
void | SetInterpolationTypeToCubic () |
virtual const char * | GetInterpolationTypeAsString () |
virtual void | SetLayerNumber (int) |
Set the layer number. More... | |
int | GetLayerNumber () |
virtual void | SetCheckerboard (vtkTypeBool) |
Make a checkerboard pattern where the black squares are transparent. More... | |
virtual void | CheckerboardOn () |
virtual void | CheckerboardOff () |
virtual vtkTypeBool | GetCheckerboard () |
virtual void | SetCheckerboardSpacing (double, double) |
The spacing for checkerboarding. More... | |
void | SetCheckerboardSpacing (double[2]) |
virtual double * | GetCheckerboardSpacing () |
virtual void | GetCheckerboardSpacing (double &, double &) |
virtual void | GetCheckerboardSpacing (double[2]) |
virtual void | SetCheckerboardOffset (double, double) |
The phase offset for checkerboarding, in units of spacing. More... | |
void | SetCheckerboardOffset (double[2]) |
virtual double * | GetCheckerboardOffset () |
virtual void | GetCheckerboardOffset (double &, double &) |
virtual void | GetCheckerboardOffset (double[2]) |
virtual void | SetBacking (vtkTypeBool) |
Use an opaque backing polygon, which will be visible where the image is translucent. More... | |
virtual void | BackingOn () |
virtual void | BackingOff () |
virtual vtkTypeBool | GetBacking () |
virtual void | SetBackingColor (double, double, double) |
Set the color of the backing polygon. More... | |
virtual void | SetBackingColor (double[3]) |
virtual double * | GetBackingColor () |
virtual void | GetBackingColor (double &, double &, double &) |
virtual void | GetBackingColor (double[3]) |
vtkMTimeType | GetMTime () override |
Get the MTime for this property. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
void | PrintRevisions (ostream &) |
Legacy. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImageProperty * | SafeDownCast (vtkObjectBase *o) |
static vtkImageProperty * | New () |
Construct a property with no lookup table. More... | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkImageProperty () | |
~vtkImageProperty () override | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkScalarsToColors * | LookupTable |
double | ColorWindow |
double | ColorLevel |
vtkTypeBool | UseLookupTableScalarRange |
int | InterpolationType |
int | LayerNumber |
double | Opacity |
double | Ambient |
double | Diffuse |
vtkTypeBool | Checkerboard |
double | CheckerboardSpacing [2] |
double | CheckerboardOffset [2] |
vtkTypeBool | Backing |
double | BackingColor [3] |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
image display properties
vtkImageProperty is an object that allows control of the display of an image slice.
Definition at line 42 of file vtkImageProperty.h.
Definition at line 45 of file vtkImageProperty.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkObjectBase.
|
static |
|
protectedvirtual |
vtkImageProperty* vtkImageProperty::NewInstance | ( | ) | const |
|
overridevirtual |
|
static |
Construct a property with no lookup table.
void vtkImageProperty::DeepCopy | ( | vtkImageProperty * | p | ) |
Assign one property to another.
|
virtual |
The window value for window/level.
|
virtual |
|
virtual |
The level value for window/level.
|
virtual |
|
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 |
|
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 |
|
virtual |
|
virtual |
|
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. The default is 1.0.
|
virtual |
|
virtual |
The ambient lighting coefficient.
The default is 1.0.
|
virtual |
|
virtual |
The diffuse lighting coefficient.
The default is 0.0.
|
virtual |
|
virtual |
The interpolation type (default: nearest neighbor).
|
virtual |
|
inline |
Definition at line 129 of file vtkImageProperty.h.
|
inline |
Definition at line 131 of file vtkImageProperty.h.
|
inline |
Definition at line 133 of file vtkImageProperty.h.
|
virtual |
|
virtual |
Set the layer number.
This is ignored unless the image is part of a vtkImageStack. The default layer number is zero.
|
inline |
Definition at line 144 of file vtkImageProperty.h.
|
virtual |
Make a checkerboard pattern where the black squares are transparent.
The pattern is aligned with the camera, and centered by default.
|
virtual |
|
virtual |
|
virtual |
The spacing for checkerboarding.
This is in real units, not pixels.
void vtkImageProperty::SetCheckerboardSpacing | ( | double | [2] | ) |
|
virtual |
|
virtual |
The phase offset for checkerboarding, in units of spacing.
Use a value between -1 and +1, where 1 is an offset of one squares.
void vtkImageProperty::SetCheckerboardOffset | ( | double | [2] | ) |
|
virtual |
|
virtual |
|
virtual |
Use an opaque backing polygon, which will be visible where the image is translucent.
When images are in a stack, the backing polygons for all images will be drawn before any of the images in the stack, in order to allow the images in the stack to be composited.
|
virtual |
|
virtual |
|
virtual |
Set the color of the backing polygon.
The default color is black.
|
virtual |
|
virtual |
|
virtual |
|
overridevirtual |
Get the MTime for this property.
If the lookup table is set, the mtime will include the mtime of the lookup table.
Reimplemented from vtkObject.
|
protected |
Definition at line 205 of file vtkImageProperty.h.
|
protected |
Definition at line 206 of file vtkImageProperty.h.
|
protected |
Definition at line 207 of file vtkImageProperty.h.
|
protected |
Definition at line 208 of file vtkImageProperty.h.
|
protected |
Definition at line 209 of file vtkImageProperty.h.
|
protected |
Definition at line 210 of file vtkImageProperty.h.
|
protected |
Definition at line 211 of file vtkImageProperty.h.
|
protected |
Definition at line 212 of file vtkImageProperty.h.
|
protected |
Definition at line 213 of file vtkImageProperty.h.
|
protected |
Definition at line 214 of file vtkImageProperty.h.
|
protected |
Definition at line 215 of file vtkImageProperty.h.
|
protected |
Definition at line 216 of file vtkImageProperty.h.
|
protected |
Definition at line 217 of file vtkImageProperty.h.
|
protected |
Definition at line 218 of file vtkImageProperty.h.