Rhino C++ API
8.10
|
#include <RhRdkContentField.h>
Public Member Functions | |
CRhRdkDynamicContentField (CRhRdkContent &c, const wchar_t *wszInternalName, const wchar_t *wszLocalName, const wchar_t *wszEnglishName, const CRhRdkVariant &vValue, const CRhRdkVariant &vMinValue, const CRhRdkVariant &vMaxValue, Filter setFilter=All, Filter getFilter=All, int sectionId=0, INT_PTR reserved=0) | |
CRhRdkDynamicContentField (CRhRdkContent &c, const wchar_t *wszInternalName, const wchar_t *wszLocalName, const wchar_t *wszEnglishName, const CRhRdkVariant &vValue, Filter setFilter=All, Filter getFilter=All, int sectionId=0, INT_PTR reserved=0) | |
virtual void * | EVF (const wchar_t *, void *) override |
virtual CRhRdkContentField * | MakeCopy (CRhRdkContent &) const override |
![]() | |
CRhRdkContentField (CRhRdkContent &c, const wchar_t *wszInternalName, const wchar_t *wszFriendlyName, eFilter setFilter=All, eFilter getFilter=All, INT_PTR reserved=0) | |
CRhRdkContentField (CRhRdkContent &c, const wchar_t *wszInternalName, const wchar_t *wszLocalName, const wchar_t *wszEnglishName, Filter setFilter=All, Filter getFilter=All, int sectionId=0, bool bDynamic=false, INT_PTR reserved=0) | |
virtual | ~CRhRdkContentField () |
const void * | AsBuffer (size_t &sizeOut) const |
void * | AsPointer (void) const |
virtual CRhRdkContent & | Content (void) const |
virtual UINT | Conversion (void) const |
virtual CRhRdkVariant | ConvertFromDisplay (const CRhRdkVariant &v) const |
virtual CRhRdkVariant | ConvertToDisplay (const CRhRdkVariant &v) const |
virtual ON_wString | EnglishName (void) const |
virtual RDK_DEPRECATED ON_wString | FriendlyName (void) const |
virtual Filter | GetFilter (void) const |
virtual bool | GetLimits (CRhRdkVariant &vMin, CRhRdkVariant &vMax) const |
virtual void | GetValueFromSection (const IRhRdk_XMLSection §ion) |
void | Initialize (const CRhRdkVariant &v) |
virtual ON_wString | InternalName (void) const |
bool | IsDynamic (void) const |
bool | IsHiddenInAutoUI (void) const |
virtual ON_wString | LocalName (void) const |
operator bool (void) const | |
operator const wchar_t * (void) const | |
operator CRhRdkColor (void) const | |
operator CRhRdkVariant (void) const | |
operator double (void) const | |
operator float (void) const | |
operator int (void) const | |
operator ON_2dVector (void) const | |
operator ON_3dVector (void) const | |
operator ON_4dPoint (void) const | |
operator ON_Color (void) const | |
operator ON_Xform (void) const | |
operator time_t (void) const | |
operator UUID (void) const | |
bool | operator!= (const CRhRdkContentField &v) const |
bool | operator< (const CRhRdkContentField &v) const |
const CRhRdkContentField & | operator= (bool b) |
const CRhRdkContentField & | operator= (const char *sz) |
const CRhRdkContentField & | operator= (const CRhRdkContentField &f) |
const CRhRdkContentField & | operator= (const CRhRdkVariant &v) |
const CRhRdkContentField & | operator= (const ON_2dVector &v) |
const CRhRdkContentField & | operator= (const ON_3dVector &v) |
const CRhRdkContentField & | operator= (const ON_4dPoint &p) |
const CRhRdkContentField & | operator= (const ON_Color &c) |
const CRhRdkContentField & | operator= (const ON_Xform &xform) |
const CRhRdkContentField & | operator= (const time_t &time) |
const CRhRdkContentField & | operator= (const UUID &uuid) |
const CRhRdkContentField & | operator= (const wchar_t *wsz) |
const CRhRdkContentField & | operator= (double d) |
const CRhRdkContentField & | operator= (float f) |
const CRhRdkContentField & | operator= (int i) |
const CRhRdkContentField & | operator= (void *p) |
bool | operator== (const CRhRdkContentField &v) const |
bool | operator> (const CRhRdkContentField &v) const |
virtual int | SectionId (void) const |
virtual void | SetConversion (UINT uFlags) |
virtual Filter | SetFilter (void) const |
void | SetIsHiddenInAutoUI (bool bHidden) |
virtual bool | SetLimits (const CRhRdkVariant &vMin, const CRhRdkVariant &vMax) |
virtual bool | SetValue (const CRhRdkVariant &vNewValue) |
virtual RDK_DEPRECATED bool | SetValue (const CRhRdkVariant &vNewValue, CRhRdkContent::eChangeContext cc) |
virtual void | SetValueToSection (IRhRdk_XMLSection §ion) const |
virtual ON_wString | UndoString (void) const |
virtual const CRhRdkVariant & | Value (void) const |
Additional Inherited Members | |
![]() | |
enum | : unsigned int { conv_none = 0x0000, conv_percentile = 0x0001, conv_one_minus = 0x0002, conv_radians = 0x0004 } |
typedef Filter | eFilter |
enum | Filter : unsigned int { None = 0x00, Serialization = 0x01, Harvesting = 0x02, Rendering = 0x04, All = 0xFF } |
![]() | |
CImpl & | Impl (void) const |
CRhRdkContentField * | NewField (CRhRdkContent &c) const |
This class makes it easier for clients to create dynamic fields in their Initialize() override or in a custom Content I/O plug-in. It is similar to a static field but can be added to the content at run-time. It is not strictly necessary to use this class to get a dynamic field, but it just makes it easier.
CRhRdkDynamicContentField::CRhRdkDynamicContentField | ( | CRhRdkContent & | c, |
const wchar_t * | wszInternalName, | ||
const wchar_t * | wszLocalName, | ||
const wchar_t * | wszEnglishName, | ||
const CRhRdkVariant & | vValue, | ||
Filter | setFilter = All , |
||
Filter | getFilter = All , |
||
int | sectionId = 0 , |
||
INT_PTR | reserved = 0 |
||
) |
Constructs a dynamic field with an initial value and no limits.
c | is the content that the field belongs to. |
wszInternalName | is the internal name of the field. Not localized. |
wszLocalName | is the localized user-friendly name of the field. |
wszEnglishName | is the English user-friendly name of the field. |
vValue | is the initial value of the field. |
setFilter | is a filter for use during CRhRdkContentFields::SetValuesToSection(). The field is skipped if setFilter does not match at least one item in the call's filter. |
getFilter | is a filter for use during CRhRdkContentFields::GetValuesFromSection(). The field is skipped if getFilter does not match at least one item in the call's filter. |
sectionId | is used for filtering fields between sections. Zero if not needed. |
reserved | is reserved for future use. Must be zero. |
CRhRdkDynamicContentField::CRhRdkDynamicContentField | ( | CRhRdkContent & | c, |
const wchar_t * | wszInternalName, | ||
const wchar_t * | wszLocalName, | ||
const wchar_t * | wszEnglishName, | ||
const CRhRdkVariant & | vValue, | ||
const CRhRdkVariant & | vMinValue, | ||
const CRhRdkVariant & | vMaxValue, | ||
Filter | setFilter = All , |
||
Filter | getFilter = All , |
||
int | sectionId = 0 , |
||
INT_PTR | reserved = 0 |
||
) |
Constructs a dynamic field with an initial value and min and max limits.
c | is the content that the field belongs to. |
wszInternalName | is the internal name of the field. Not localized. |
wszLocalName | is the localized user-friendly name of the field. |
wszEnglishName | is the English user-friendly name of the field. |
vValue | is the initial value of the field. |
vMinValue | is the minimum value of the field. Must be the same type as vValue. |
vMaxValue | is the maximum value of the field. Must be the same type as vValue. |
setFilter | is a filter for use during CRhRdkContentFields::SetValuesToSection(). The field is skipped if setFilter does not match at least one item in the call's filter. |
getFilter | is a filter for use during CRhRdkContentFields::GetValuesFromSection(). The field is skipped if getFilter does not match at least one item in the call's filter. |
sectionId | is used for filtering fields between sections. Zero if not needed. |
reserved | is reserved for future use. Must be zero. |
|
overridevirtual |
Emergency virtual function for future expansion.
Reimplemented from CRhRdkContentField.
|
overridevirtual |
Return an exact copy of this field, with the same value and type.
Reimplemented from CRhRdkContentField.