Skip to content

classHPropertyInfo 02

Member Enumeration Documentation

enum HPropertyInfo::DrawWhen
 

Controls when the property will be displayed in the PWS for the user to enter values.

From the SDK point of view, a plugin possess a list of properties which are all grouped together inside a property panel. The panel is displayable by clicking on the little expand triangle that is visible on a node of the PWS tree.

A plugin property pannel may be accessible from different context. For example, the properties for a turbulence plugin may be accessible from a material node, from a material shortcut on a model or on a group and from a material shortcut on a model shortcut in choreography. For some particular properties, it may be desirable to let the user modify them only when inside a material node for instance.

See also:
HPropertyInfo::GetDrawWhen, HPropertyInfo::SetDrawWhen
Enumerator:
DRAWNEVER  The property will never be displayed in the PWS. This can be used for a plugin to store values that might be retrieved from call to call.
DRAWALWAYS  The property will always be displayed in the PWS, no matter the context in which the property panel is displayed.
DRAWIFSHADED 
DRAWIFFLARES 
DRAWIFMATERIALS  The property will only be displayed if the property panel is displayed inside a material node. It will not be displayed when the property panel is inside a material shortcut on a model or group or is inside a material shortcut on a model shortcut in choreography.
DRAWIFPARTICLES 

Definition at line 26 of file HPropert.h.

enum HPropertyInfo::VisibleWhen
 

Controls how a plugin can switch visibility of a property in the PWS for the user to enter values.

This is different than DrawWhen in that VisibleWhen imposes restriction on the actions of HProperty::Show during plugin execution.

See also:
HPropertyInfo::GetVisibleWhen, HPropertyInfo::SetVisibleWhen
Enumerator:
VISIBLENEVER  The property will never be visible. Even when HProperty::Show(TRUE) is called.
VISIBLEALWAYS  The property will always be visible. Even when HProperty::Show(FALSE) is called. This is the default visibility behavior.
VISIBLECACHEONLY  The property will be visible or hidden only when the property pannel is in the original model, material, etc. It will not be visible and cannot be made visible when on an instance of a model, a material, etc.
VISIBLEINSTANCEONLY  The property may only be made visible or hidden when the property pannel is on an instance (a shortcut) of an original model, material, etc. It will not be visible and cannot be made visible when on an original model, material, etc.
VISIBLESOMETIMES  The property may be visible or hidden as required by the plugin internal status by calling HProperty::Show.

Definition at line 27 of file HPropert.h.