vtkKWMaterialPropertyWidget Class Reference

widget to control the material property of a volume More...

#include <vtkKWMaterialPropertyWidget.h>

Inheritance diagram for vtkKWMaterialPropertyWidget:

[legend]

Collaboration diagram for vtkKWMaterialPropertyWidget:

[legend]

List of all members.

Classes
class	Preset
Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual void	UpdatePreview ()
virtual void	UpdateEnableState ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkKWMaterialPropertyWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWMaterialPropertyWidget ()
	~vtkKWMaterialPropertyWidget ()
virtual void	CreateWidget ()
virtual void	InvokePropertyChangedCommand ()
virtual void	InvokePropertyChangingCommand ()
virtual void	Pack ()
virtual void	SendStateEvent (int event)
virtual void	AddDefaultPresets ()
virtual void	CreatePresets ()
virtual void	UpdatePopupPreview ()
virtual int	AreControlsEnabled ()
Protected Attributes
int	PopupMode
int	PreviewSize
int	PresetSize
int	PopupPreviewSize
double	GridOpacity
int	LightingParametersVisibility
double	MaterialColor [3]
vtkKWMaterialPropertyWidgetInternals *	Internals
vtkKWPopupButtonWithLabel *	PopupButton
vtkKWFrameWithLabel *	MaterialPropertiesFrame
vtkKWFrame *	ControlFrame
vtkKWFrame *	LightingFrame
vtkKWScaleWithEntry *	AmbientScale
vtkKWScaleWithEntry *	DiffuseScale
vtkKWScaleWithEntry *	SpecularScale
vtkKWScaleWithEntry *	SpecularPowerScale
vtkKWFrame *	PresetsFrame
vtkKWLabelWithLabel *	PreviewLabel
vtkKWPushButtonSetWithLabel *	PresetPushButtonSet
Friends
class	vtkKWMaterialPropertyWidgetInternals

int	PropertyChangedEvent
int	PropertyChangingEvent
char *	PropertyChangedCommand
char *	PropertyChangingCommand
virtual void	SetPopupMode (int)
virtual int	GetPopupMode ()
virtual void	PopupModeOn ()
virtual void	PopupModeOff ()
virtual vtkKWPopupButtonWithLabel *	GetPopupButton ()
virtual void	SetPreviewSize (int)
virtual void	SetPresetSize (int)
virtual void	SetPopupPreviewSize (int)
virtual int	GetPreviewSize ()
virtual int	GetPresetSize ()
virtual int	GetPopupPreviewSize ()
virtual void	SetGridOpacity (double)
virtual double	GetGridOpacity ()
virtual double *	GetMaterialColor ()
virtual void	GetMaterialColor (double &, double &, double &)
virtual void	GetMaterialColor (double[3])
void	SetMaterialColor (double r, double g, double b)
void	SetMaterialColor (double color[3])
virtual void	SetLightingParametersVisibility (int)
virtual void	LightingParametersVisibilityOn ()
virtual void	LightingParametersVisibilityOff ()
virtual int	GetLightingParametersVisibility ()
virtual void	SetPropertyChangedEvent (int)
virtual int	GetPropertyChangedEvent ()
virtual void	SetPropertyChangingEvent (int)
virtual int	GetPropertyChangingEvent ()
virtual void	SetPropertyChangedCommand (vtkObject object, const char method)
virtual void	SetPropertyChangingCommand (vtkObject object, const char method)
virtual void	PropertyChangingCallback (double value)
virtual void	PropertyChangedCallback (double value)
virtual void	PresetMaterialCallback (int preset_idx)
virtual void	CreateImage (unsigned char *data, double ambient, double diffuse, double specular, double specular_power, int size)
virtual int	UpdatePropertyFromInterface ()=0
virtual int	UpdatePropertyFromPreset (const Preset *preset)=0
virtual int	UpdateScalesFromPreset (const Preset *preset)
virtual void	UpdateScales (double ambient, double diffuse, double specular, double specular_power)

Detailed Description

widget to control the material property of a volume

Definition at line 34 of file vtkKWMaterialPropertyWidget.h.

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWMaterialPropertyWidget::Superclass

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

Definition at line 38 of file vtkKWMaterialPropertyWidget.h.

Constructor & Destructor Documentation

vtkKWMaterialPropertyWidget::vtkKWMaterialPropertyWidget ( ) [protected]

vtkKWMaterialPropertyWidget::~vtkKWMaterialPropertyWidget ( ) [protected]

Member Function Documentation

virtual const char* vtkKWMaterialPropertyWidget::GetClassName ( ) [virtual]

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

static int vtkKWMaterialPropertyWidget::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

virtual int vtkKWMaterialPropertyWidget::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

static vtkKWMaterialPropertyWidget* vtkKWMaterialPropertyWidget::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

virtual void vtkKWMaterialPropertyWidget::SetPopupMode ( int ) [virtual]

Display the UI as a popup (default is off). The pushbutton will display a representation of the current properties. This has to be called before Create().

virtual int vtkKWMaterialPropertyWidget::GetPopupMode ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::PopupModeOn ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::PopupModeOff ( ) [virtual]

Events

virtual vtkKWPopupButtonWithLabel* vtkKWMaterialPropertyWidget::GetPopupButton ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::Update ( ) [virtual]

Refresh the interface given the value extracted from the current widget.

Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

virtual void vtkKWMaterialPropertyWidget::UpdatePreview ( ) [virtual]

Update the preview according to current settings

virtual void vtkKWMaterialPropertyWidget::SetPreviewSize ( int ) [virtual]

Set/Get the size of the preview, presets and popup preview images

virtual void vtkKWMaterialPropertyWidget::SetPresetSize ( int ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::SetPopupPreviewSize ( int ) [virtual]

Events

virtual int vtkKWMaterialPropertyWidget::GetPreviewSize ( ) [virtual]

Events

virtual int vtkKWMaterialPropertyWidget::GetPresetSize ( ) [virtual]

Events

virtual int vtkKWMaterialPropertyWidget::GetPopupPreviewSize ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::SetGridOpacity ( double ) [virtual]

Set/Get the grid opacity in the preview/presets

virtual double vtkKWMaterialPropertyWidget::GetGridOpacity ( ) [virtual]

Events

virtual double* vtkKWMaterialPropertyWidget::GetMaterialColor ( ) [virtual]

Set/Get the color of the preview/presets.

virtual void vtkKWMaterialPropertyWidget::GetMaterialColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

Events

virtual void vtkKWMaterialPropertyWidget::GetMaterialColor ( double [3] ) [virtual]

Events

void vtkKWMaterialPropertyWidget::SetMaterialColor	(	double	r,
		double	g,
		double	b
	)

Events

void vtkKWMaterialPropertyWidget::SetMaterialColor ( double color[3] ) [inline]

Events

Definition at line 78 of file vtkKWMaterialPropertyWidget.h.

virtual void vtkKWMaterialPropertyWidget::SetLightingParametersVisibility ( int ) [virtual]

Set/Get the lighting parameters visibility. If set to Off, none of the ambient, diffuse, specular (etc.) scales will be displayed.

virtual void vtkKWMaterialPropertyWidget::LightingParametersVisibilityOn ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::LightingParametersVisibilityOff ( ) [virtual]

Events

virtual int vtkKWMaterialPropertyWidget::GetLightingParametersVisibility ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::SetPropertyChangedEvent ( int ) [virtual]

Set/Get the event invoked when the property is changed/changing. Defaults to vtkKWEvent::MaterialPropertyChanged/ingEvent, this default is likely to change in subclasses to reflect what kind of property is changed (vtkKWEvent::VolumeMaterialPropertyChangedEvent for example).

virtual int vtkKWMaterialPropertyWidget::GetPropertyChangedEvent ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::SetPropertyChangingEvent ( int ) [virtual]

Events

virtual int vtkKWMaterialPropertyWidget::GetPropertyChangingEvent ( ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::SetPropertyChangedCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Specifies commands to associate with the widget. 'PropertyChangedCommand' is invoked when the property has changed (i.e. at the end of the user interaction). 'PropertyChangingCommand' is invoked when the selected color is changing (i.e. during the user interaction). The need for a '...ChangedCommand' and '...ChangingCommand' can be explained as follows: the former can be used to be notified about any changes made to this widget *after* the corresponding user interaction has been performed (say, after releasing the mouse button that was dragging a slider, or after clicking on a checkbutton). The later can be set *additionally* to be notified about the intermediate changes that occur *during* the corresponding user interaction (say, *while* dragging a slider). While setting '...ChangedCommand' is enough to be notified about any changes, setting '...ChangingCommand' is an application-specific choice that is likely to depend on how fast you want (or can) answer to rapid changes occuring during a user interaction, if any. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWMaterialPropertyWidget::SetPropertyChangingCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Events

virtual void vtkKWMaterialPropertyWidget::UpdateEnableState ( ) [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWWidget.

Reimplemented in vtkKWVolumeMaterialPropertyWidget.

virtual void vtkKWMaterialPropertyWidget::PropertyChangingCallback ( double value ) [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWMaterialPropertyWidget::PropertyChangedCallback ( double value ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::PresetMaterialCallback ( int preset_idx ) [virtual]

Events

virtual void vtkKWMaterialPropertyWidget::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWVolumeMaterialPropertyWidget.

virtual void vtkKWMaterialPropertyWidget::InvokePropertyChangedCommand ( ) [protected, virtual]

virtual void vtkKWMaterialPropertyWidget::InvokePropertyChangingCommand ( ) [protected, virtual]

virtual void vtkKWMaterialPropertyWidget::Pack ( ) [protected, virtual]

Pack

Reimplemented in vtkKWVolumeMaterialPropertyWidget.

virtual void vtkKWMaterialPropertyWidget::CreateImage	(	unsigned char *	data,
		double	ambient,
		double	diffuse,
		double	specular,
		double	specular_power,
		int	size
	)			`[protected, virtual]`