IAutoUIExtraRequirements Class Reference

#include <IAutoUIExtraRequirements.h>

Inheritance diagram for IAutoUIExtraRequirements:

Public Types
enum	SetContext : unsigned int { SetContext::UI, SetContext::Drop, SetContext::Program }

Public Member Functions
virtual	~IAutoUIExtraRequirements ()
virtual IAutoUIExtraRequirements *	DuplicateExtraRequirementsInterface (void) const =0
virtual void *	EVF (const wchar_t *, void *)=0
virtual bool	GetExtraRequirementParameter (const wchar_t *wszParamName, const wchar_t *wszExtraReqName, CRhRdkVariant &vValueOut) const =0
virtual bool	OnExtraRequirementButtonClicked (const wchar_t *wszParamName, const wchar_t *wszButtonName)=0
virtual bool	SetExtraRequirementParameter (const wchar_t *wszParamName, const wchar_t *wszExtraReqName, const CRhRdkVariant &vValue, SetContext sc)=0

Detailed Description

Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. All objects that support such extra UI requirements must implement this interface.

RDK currently supports the following extra requirements:

• RDK_TEXTURING Provides texturing controls; an 'on' checkbox, an 'amount' edit box, and a 'subnode' control.
• RDK_EXCLUDE_LIST Provides support for exclude lists (lists of things to be excluded from some operation).
• RDK_ENABLE_DISABLE Provides an 'on' checkbox for enable/disable of the control set.
• RDK_FIXED_DECIMAL_PLACES Allows customization of number of decimal places displayed in a numeric edit box.
• RDK_NUMBER_EDIT_TWEAKS Allows tweaking of numeric edit boxes.
• RDK_COLOR_BUTTON_TWEAKS Allows tweaking of color buttons.
• RDK_IOR_MENU Requests a context menu containing the indices of refraction for all kinds of substances.
• RDK_COMBOBOX
• RDK_DATETIME Requests a callback for providing date/time information to the date-time or location controls.
• RDK_LOCATION Requests a callback for providing location information to the date-time or location controls.
• RDK_CONTROLSET_ENABLE Requests a general enable/disable callback.

Member Enumeration Documentation

SetContext

enum IAutoUIExtraRequirements::SetContext : unsigned int

strong

Enumerator
UI
Drop
Program

Constructor & Destructor Documentation

~IAutoUIExtraRequirements()

virtual IAutoUIExtraRequirements::~IAutoUIExtraRequirements ( )

inlinevirtual

Member Function Documentation

DuplicateExtraRequirementsInterface()

virtual IAutoUIExtraRequirements* IAutoUIExtraRequirements::DuplicateExtraRequirementsInterface ( void  ) const

pure virtual

Returns

A duplicate of the object that implements the interface.

Implemented in CRhRdkContent.

EVF()

virtual void* IAutoUIExtraRequirements::EVF ( const wchar_t *  , void *    )

pure virtual

Emergency virtual function for future expansion.

Implemented in CRhRdkTexture, CRhRdkMaterial, CRhRdkCoreContent, CRhRdkEnvironment, and CRhRdkContent.

GetExtraRequirementParameter()

virtual bool IAutoUIExtraRequirements::GetExtraRequirementParameter ( const wchar_t *  wszParamName, const wchar_t *  wszExtraReqName, CRhRdkVariant &  vValueOut  ) const

pure virtual

Implement this method to get a parameter for extra UI requirements.

Parameters

wszParamName	is the name of the content parameter for which to get an extra req. parameter.
wszExtraReqName	is the name of the extra requirement parameter to retrieve.
vValueOut	receives the parameter's value. For the enabled-on checkbox Checked property, 0 means false, 1 means true, 2 means null (indeterminate).

Returns

true if the parameter was retrieved successfuly, else false.

Implemented in CRhRdkBasicMaterial, CRhRdkTwoColorTextureBase, CRhRdkOneColorTextureBase, and CRhRdkContent.

OnExtraRequirementButtonClicked()

virtual bool IAutoUIExtraRequirements::OnExtraRequirementButtonClicked ( const wchar_t *  wszParamName, const wchar_t *  wszButtonName  )

pure virtual

Implement this method to handle an extra UI requirements button click.

Parameters

wszParamName	is the name of the content parameter for which a button was clicked.
wszButtonName	is the name of the button that was clicked.

Returns

true if button click was handled successfully, else false.

Implemented in CRhRdkContent.

SetExtraRequirementParameter()

virtual bool IAutoUIExtraRequirements::SetExtraRequirementParameter ( const wchar_t *  wszParamName, const wchar_t *  wszExtraReqName, const CRhRdkVariant &  vValue, SetContext  sc  )

pure virtual

Implement this method to set a parameter for extra UI requirements.

Parameters

wszParamName	is the name of the content parameter for which to set an extra req. parameter.
wszExtraReqName	is the name of the extra requirement parameter to be set.
vValue	contains the new value for the specified extra req. parameter. For the enabled-on checkbox Checked property, 0 means false, 1 means true, 2 means null (indeterminate).
sc	is the context in which the set operation is being performed.

Returns

true if the parameter was set successfuly, else false.

Implemented in CRhRdkBasicMaterial, CRhRdkTwoColorTextureBase, CRhRdkOneColorTextureBase, and CRhRdkContent.