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:


Public Member Functions
	vtkTypeRevisionMacro (vtkKWMaterialPropertyWidget, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	Update ()
virtual void	UpdatePreview ()
virtual void	UpdateEnableState ()

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	InvokePropertyChangedCommand ()
virtual void	InvokePropertyChangingCommand ()

virtual void	PropertyChangingCallback ()
virtual void	PropertyChangedCallback ()
virtual void	PresetMaterialCallback (int preset_idx)
Protected Member Functions
	vtkKWMaterialPropertyWidget ()
	~vtkKWMaterialPropertyWidget ()
virtual void	InvokeCommand (const char *command)
virtual void	Pack ()
virtual void	SendStateEvent (int event)
virtual void	AddDefaultPresets ()
virtual void	CreatePresets ()
virtual void	UpdatePopupPreview ()
virtual int	AreControlsEnabled ()

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)
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

int	PropertyChangedEvent
int	PropertyChangingEvent

char *	PropertyChangedCommand
char *	PropertyChangingCommand
Friends
class	vtkKWMaterialPropertyWidgetInternals

Detailed Description

widget to control the material property of a volume

Definition at line 35 of file vtkKWMaterialPropertyWidget.h.

Constructor & Destructor Documentation

vtkKWMaterialPropertyWidget::vtkKWMaterialPropertyWidget ( ) [protected]

vtkKWMaterialPropertyWidget::~vtkKWMaterialPropertyWidget ( ) [protected]

Member Function Documentation

vtkKWMaterialPropertyWidget::vtkTypeRevisionMacro ( vtkKWMaterialPropertyWidget ,

vtkKWCompositeWidget

)

void vtkKWMaterialPropertyWidget::PrintSelf ( ostream & os,

vtkIndent indent

)

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]

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 void vtkKWMaterialPropertyWidget::PopupModeOn ( ) [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 void vtkKWMaterialPropertyWidget::PopupModeOff ( ) [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 vtkKWPopupButtonWithLabel* vtkKWMaterialPropertyWidget::GetPopupButton ( ) [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 void vtkKWMaterialPropertyWidget::Create ( vtkKWApplication * app ) [virtual]

Create the widget.
Reimplemented from vtkKWCompositeWidget.
Reimplemented in vtkKWVolumeMaterialPropertyWidget.

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]

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

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

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

virtual int vtkKWMaterialPropertyWidget::GetPreviewSize ( ) [virtual]

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

virtual int vtkKWMaterialPropertyWidget::GetPresetSize ( ) [virtual]

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

virtual int vtkKWMaterialPropertyWidget::GetPopupPreviewSize ( ) [virtual]

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

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

Set/Get the grid opacity in the preview/presets

virtual double vtkKWMaterialPropertyWidget::GetGridOpacity ( ) [virtual]

Set/Get the grid opacity in the preview/presets

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

Set/Get the color of the preview/presets.

virtual void vtkKWMaterialPropertyWidget::GetMaterialColor ( double & ,

double & ,

double &

) [virtual]

Set/Get the color of the preview/presets.

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

Set/Get the color of the preview/presets.

void vtkKWMaterialPropertyWidget::SetMaterialColor ( double r,

double g,

double b

)

Set/Get the color of the preview/presets.

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

Set/Get the color of the preview/presets.
Definition at line 81 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]

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

virtual void vtkKWMaterialPropertyWidget::LightingParametersVisibilityOff ( ) [virtual]

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

virtual int vtkKWMaterialPropertyWidget::GetLightingParametersVisibility ( ) [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::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]

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 void vtkKWMaterialPropertyWidget::SetPropertyChangingEvent ( 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::GetPropertyChangingEvent ( ) [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 void vtkKWMaterialPropertyWidget::SetPropertyChangedCommand ( vtkObject * object,

const char * method

) [virtual]

Set the command that will be called when the property is changed/changing.

virtual void vtkKWMaterialPropertyWidget::SetPropertyChangingCommand ( vtkObject * object,

const char * method

) [virtual]

Set the command that will be called when the property is changed/changing.

virtual void vtkKWMaterialPropertyWidget::InvokePropertyChangedCommand ( ) [virtual]

Set the command that will be called when the property is changed/changing.

virtual void vtkKWMaterialPropertyWidget::InvokePropertyChangingCommand ( ) [virtual]

Set the command that will be called when the property is changed/changing.

virtual void vtkKWMaterialPropertyWidget::PropertyChangingCallback ( ) [virtual]

Callbacks for the buttons, scales and presets

virtual void vtkKWMaterialPropertyWidget::PropertyChangedCallback ( ) [virtual]

Callbacks for the buttons, scales and presets

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

Callbacks for the buttons, scales and presets

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::InvokeCommand ( const char * command ) [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]

Create a preview image given some material properties

virtual void vtkKWMaterialPropertyWidget::SendStateEvent ( int event ) [protected, virtual]

Send an event representing the state of the widget
Reimplemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

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

Add default presets

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

Create the presets

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

Update the popup preview according to current settings

virtual int vtkKWMaterialPropertyWidget::UpdatePropertyFromInterface ( ) [protected, pure virtual]

Update the property from the interface values or a preset Return 1 if the property was modified, 0 otherwise
Implemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

virtual int vtkKWMaterialPropertyWidget::UpdatePropertyFromPreset ( const Preset * preset ) [protected, pure virtual]

Update the property from the interface values or a preset Return 1 if the property was modified, 0 otherwise
Implemented in vtkKWSurfaceMaterialPropertyWidget, and vtkKWVolumeMaterialPropertyWidget.

virtual int vtkKWMaterialPropertyWidget::UpdateScalesFromPreset ( const Preset * preset ) [protected, virtual]

Update the scales from a preset

virtual void vtkKWMaterialPropertyWidget::UpdateScales ( double ambient,

double diffuse,

double specular,

double specular_power

) [protected, virtual]

Update the scales from a preset

virtual int vtkKWMaterialPropertyWidget::AreControlsEnabled ( ) [inline, protected, virtual]

Return 1 if the controls should be enabled.
Reimplemented in vtkKWVolumeMaterialPropertyWidget.
Definition at line 236 of file vtkKWMaterialPropertyWidget.h.

Friends And Related Function Documentation

friend class vtkKWMaterialPropertyWidgetInternals [friend]

Definition at line 177 of file vtkKWMaterialPropertyWidget.h.

Member Data Documentation

int vtkKWMaterialPropertyWidget::PopupMode [protected]

Definition at line 136 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::PreviewSize [protected]

Definition at line 137 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::PresetSize [protected]

Definition at line 138 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::PopupPreviewSize [protected]

Definition at line 139 of file vtkKWMaterialPropertyWidget.h.

double vtkKWMaterialPropertyWidget::GridOpacity [protected]

Definition at line 140 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::LightingParametersVisibility [protected]

Definition at line 141 of file vtkKWMaterialPropertyWidget.h.

double vtkKWMaterialPropertyWidget::MaterialColor[3] [protected]

Definition at line 143 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::PropertyChangedEvent [protected]

Events
Definition at line 147 of file vtkKWMaterialPropertyWidget.h.

int vtkKWMaterialPropertyWidget::PropertyChangingEvent [protected]

Events
Definition at line 148 of file vtkKWMaterialPropertyWidget.h.

char* vtkKWMaterialPropertyWidget::PropertyChangedCommand [protected]

Commands
Definition at line 153 of file vtkKWMaterialPropertyWidget.h.

char* vtkKWMaterialPropertyWidget::PropertyChangingCommand [protected]

Commands
Definition at line 154 of file vtkKWMaterialPropertyWidget.h.

vtkKWMaterialPropertyWidgetInternals* vtkKWMaterialPropertyWidget::Internals [protected]

PIMPL Encapsulation for STL containers
Reimplemented from vtkKWWidget.
Definition at line 176 of file vtkKWMaterialPropertyWidget.h.