Rhino C++ API
8.6
|
#include <RhRdkAutomaticUI.h>
Classes | |
class | IIterator |
class | IParam |
Public Types | |
enum | eSortBy { paramName, friendlyName } |
enum | SortBy : unsigned int { SortBy::ParamName, SortBy::DisplayName } |
enum | UiHints : unsigned int { UiHints::None, UiHints::Folder, UiHints::Filename, UiHints::Combo, UiHints::Solar, UiHints::Location } |
Public Member Functions | |
virtual | ~IRhRdkParamBlock () |
virtual bool | Add (const wchar_t *wszParamName, const wchar_t *wszChildSlotName, const wchar_t *wszDisplayName, const CRhRdkVariant &vValue, const CRhRdkVariant &vMin, const CRhRdkVariant &vMax, UiHints uih=UiHints::None, const wchar_t *wszExtraRequirementSet=nullptr, const IAutoUIExtraRequirements *pExtraRequirements=nullptr)=0 |
virtual void | Clear (void)=0 |
virtual void | DeleteThis (void)=0 |
virtual void * | EVF (const wchar_t *, void *)=0 |
virtual bool | Get (const wchar_t *wszParamName, CRhRdkVariant &vValueOut) const =0 |
virtual const IParam * | GetParam (const wchar_t *wszParamName) const =0 |
virtual IParam * | GetParam (const wchar_t *wszParamName)=0 |
virtual IIterator * | NewIterator (void) const =0 |
virtual bool | Remove (const wchar_t *wszParamName)=0 |
virtual void | Sort (SortBy by)=0 |
Static Public Member Functions | |
static IRhRdkParamBlock * | New (IRhinoUiDataSource &ds) |
static IRhRdkParamBlock * | New (void) |
RDK provides automatic user interface services that allow the user to manipulate arbitrary sets of named parameters which can be stored inside your RDK plug-in. RDK accesses the parameters by means of the IRhRdkParamBlock interface. This interface is only implemented inside RDK.
|
strong |
|
strong |
|
inlinevirtual |
|
pure virtual |
Add a parameter to the collection.
wszParamName | is the name of the parameter to add. If a parameter with this name already exists, the function will fail. |
wszChildSlotName | is the child slot name associated with the parameter. |
wszDisplayName | is the localized display name of the parameter. |
vValue | is the parameter's value. |
vMin | is the parameter's minimum value (optional, can be nil). |
vMax | is the parameter's maximum value (optional, can be nil). |
uih | allows the UI to be enhanced by interpreting the value in a special way. |
wszExtraRequirementSet | is the optional name of an extra requirement set. |
pExtraRequirements | is a pointer to an extra requirement interface. If wszExtraRequirementSet is specified, this pointer cannot be null. |
|
pure virtual |
Clear the collection.
|
pure virtual |
This method is implemented as
|
pure virtual |
Emergency virtual function for future expansion.
|
pure virtual |
Get a parameter from the collection by its internal name.
|
pure virtual |
|
pure virtual |
|
static |
|
static |
|
pure virtual |
Get an iterator to use when calling Next(). The caller shall delete the iterator.
|
pure virtual |
Remove a parameter from the collection.
|
pure virtual |
Sort the collection.