DzShaderPane Class Reference
[Interface Components]

Pane for displaying/editing material settings. More...

Inheritance diagram for DzShaderPane:

DzPane List of all members.

Enumerations

enum  ListPosition { Left, Top }
enum  SortType { SortNone = -1, SortAscending = 1, SortDescending = 0 }

Methods

void closeAll ()
void expandAll ()
Boolean getAutoBake ()
DzBakerOptions getBakerOption ()
ListPosition getListPosition () const
Boolean getUseBake ()
void refreshBakeTexture ()
void setAutoBake (Boolean onOff)
void setListPosition (ListPosition pos)
void setUseBake (Boolean onOff)
Boolean showingSurfaceList ()
void showPage (Number which)
void showSurfaceList (Boolean onOff)
void sort (SortType sortType)
SortType sortType ()
void toggleSurfaceList ()
void updateSurfaces ()

Deprecated



void doSortOrder (Number which)
void sortAscending ()
void sortDescending ()
void sortNone ()

Signals

void autoBakeChanged (Boolean onOff)
 Signature: "autoBakeChanged(bool)"
void listPositionChanged (ListPosition pos)
 Signature: "listPositionChanged(DzShaderPane::ListPosition)"
void showSurfaceListChanged (Boolean onOff)
 Signature: "showSurfaceListChanged(bool)"
void sortingChanged (SortType sortType)
 Signature: "sortingChanged(DzShaderPane::SortType)"
void useBakeChanged (Boolean onOff)
 Signature: "useBakeChanged(bool)"

Detailed Description

Pane for displaying/editing material settings.

This is the 'Surfaces' tab in DAZ Studio. There is only one instance of this object in DAZ Studio which belongs to the pane manager. You can get the surfaces tab by calling DzPaneMgr::findPane() with "DzShaderPane" as the argument.


Member Enumeration Documentation

enum DzShaderPane::ListPosition

The possible positions for the surfaces list in the pane.

Enumerator:
Left  The surfaces list is on the left side of the pane.
Top  The surfaces list is on the top of the pane.

enum DzShaderPane::SortType

Sorting Methods for the surface list

Enumerator:
SortNone  Items are not sorted
SortAscending  Items are sorted alphabetically by name in A-Z order
SortDescending  Items are sorted alphabetically by name in Z-A order


Member Function Documentation

DzShaderPane::autoBakeChanged ( Boolean  onOff  )  [signal]

Signature: "autoBakeChanged(bool)"

Emitted when the automatic baking settings have changed.

Parameters:
onOff The new value of the auto bake setting.
See also:
setAutoBake(), getAutoBake()

void DzShaderPane::closeAll (  ) 

Minimizes all the entries in the materials list

void DzShaderPane::doSortOrder ( Number  which  ) 

Deprecated:
New code should use the sort() function instead.

void DzShaderPane::expandAll (  ) 

Expands all the entries in the materials list

bool DzShaderPane::getAutoBake (  ) 

Returns:
true if automatic baking is turned on, otherwise false.

DzBakerOptions DzShaderPane::getBakerOption (  ) 

Returns:
The current shader baking options.

DzShaderPane::ListPosition DzShaderPane::getListPosition (  )  const

Returns:
true if the list of surfaces is laid out along the top of the material settings tab, false if the list is laid out along the side of the tab.

bool DzShaderPane::getUseBake (  ) 

Returns:
true if the results of a shader baking operation are applied, otherwise false.

void DzShaderPane::listPositionChanged ( DzShaderPane::ListPosition  pos  )  [signal]

Signature: "listPositionChanged(DzShaderPane::ListPosition)"

Emitted when the list position has changed.

Parameters:
pos The new list position.
See also:
setListPosition(), getListPosition()

void DzShaderPane::refreshBakeTexture (  ) 

Triggers a refresh of baked textures.

void DzShaderPane::setAutoBake ( Boolean  onOff  ) 

Sets automatic baking on or off.

Parameters:
onOff If true, automatic baking is turned on, otherwise, automatic baking is turned off.

void DzShaderPane::setListPosition ( ListPosition  pos  ) 

Sets the surface list to be on the top or on the side of the pane.

void DzShaderPane::setUseBake ( Boolean  onOff  ) 

Sets whether or not the results of a shader baking operation are applied.

Parameters:
onOff If true, baking results are applied, otherwise, the results are not used.

Boolean DzShaderPane::showingSurfaceList (  ) 

Returns:
true if the list of surfaces is shown along side of the material settings, false if the user must access the surface list through the dropdown.

void DzShaderPane::showPage ( Number  which  ) 

Sets the current tab shown in the material settings area.

Parameters:
which The tab to bring to the top (0 for basic, 1 for advanced)

void DzShaderPane::showSurfaceList ( Boolean  onOff  ) 

Sets the surface list to be shown as a popup menu, or an intergral widget. If true, it will be shown along side of the material settings tab. If false, it will only be available only as a popup menu activated by a button.

DzShaderPane::showSurfaceListChanged ( Boolean  onOff  )  [signal]

Signature: "showSurfaceListChanged(bool)"

Emitted when the surface list is shown/hidden.

See also:
showSurfaceList(), showingSurfaceList()

void DzShaderPane::sort ( SortType  sortType  ) 

Set the sorting method for items in the list

void DzShaderPane::sortAscending (  ) 

Deprecated:
New code should use the sort() function instead.

void DzShaderPane::sortDescending (  ) 

Deprecated:
New code should use the sort() function instead.

void DzShaderPane::sortingChanged ( DzShaderPane::SortType  sortType  )  [signal]

Signature: "sortingChanged(DzShaderPane::SortType)"

Emitted when sorting style has changed.

void DzShaderPane::sortNone (  ) 

Deprecated:
New code should use the sort() function instead.

SortType DzShaderPane::sortType (  ) 

Returns:
The current sorting style for items in the list

void DzShaderPane::toggleSurfaceList (  ) 

Toggles the surface list to be shown as a popup menu, or an intergral widget.

See also:
showSurfaceList()

void DzShaderPane::updateSurfaces (  ) 

Triggers an update of bake settings for all materials in the scene.

DzShaderPane::useBakeChanged ( Boolean  onOff  )  [signal]

Signature: "useBakeChanged(bool)"

Emitted when the use baking settings have changed.

Parameters:
onOff The new value of the use bake setting.
See also:
setUseBake(), getUseBake()


Generated on Thu Sep 24 12:21:15 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.