Rhino C++ API  8.7
Public Types | Public Member Functions | List of all members
CRhRdkCoreContent Class Reference

#include <RhRdkCoreContent.h>

Inheritance diagram for CRhRdkCoreContent:
CRhRdkContent CRhRdkObject IAutoUIExtraRequirements CRhRdkEnvironment CRhRdkMaterial CRhRdkTexture CRhRdkBasicMaterialBase CRhRdkOneColorTextureBase CRhRdkBasicMaterial CRhRdkBasicOneColorTextureBase CRhRdkTwoColorTextureBase CRhRdkBasicTwoColorTextureBase

Public Types

enum  SectionId : int { TextureSummary = 0x8000, NotUsed = 0x8001 }
- Public Types inherited from CRhRdkContent
enum  : unsigned int {
  bfTextureSummary = 0x0001, bfQuickPreview = 0x0002, bfPreviewCache = 0x0004, bfLocalTextureMapping = 0x0010,
  bfGraphDisplay = 0x0020, bfAdjustment = 0x0080, bfFields = 0x0100, bfNameTypeSection = 0x0800
enum  {
  pg_unused = 0x00000000, pg_sphere = 0x00000001, pg_cube = 0x00000002, pg_cone = 0x00000004,
  pg_pyramid = 0x00000008, pg_torus = 0x00000010, pg_plane = 0x00000020, pg_cone_sphere = 0x00010000,
  pg_scene = 0x00020000, pg_default_mat = pg_sphere | pg_cube | pg_cone | pg_pyramid | pg_torus | pg_plane | pg_scene, pg_default_env = pg_cone_sphere, pg_default_tex = pg_unused,
  pg_mat_scene = pg_scene, force32bit_pgflags = 0xFFFFFFFF
enum  {
  pb_unused = 0x00000000, pb_none = 0x00000001, pb_checker = 0x00000002, pb_custom = 0x00000004,
  pb_scene = 0x00000008, pb_default_mat = pb_none | pb_checker | pb_custom | pb_scene, pb_default_env = pb_unused, pb_default_tex = pb_unused,
  force32bit_pbflags = 0xFFFFFFFF
enum  {
  pl_unused = 0x00000000, pl_simple = 0x00000001, pl_sky = 0x00000002, pl_default_mat = pl_simple | pl_sky,
  pl_default_env = pl_unused, pl_default_tex = pl_unused, force32bit_plflags = 0xFFFFFFFF
enum  CopyMethods : unsigned int { CopyMethods::Normal, CopyMethods::Transient }
enum  CSIContext : unsigned int { CSIContext::All = 0, CSIContext::TextureSummary = 1, CSIContext::Private1 = 2, CSIContext::Private2 = 3 }
enum  DupOpt { DupOpt::Attach, DupOpt::NoAttach }
enum  DynamicIconUsage : unsigned int { DynamicIconUsage::TreeControl, DynamicIconUsage::SubnodeControl, DynamicIconUsage::ContentControl, DynamicIconUsage::General }
enum  EmbedFilesChoice : unsigned int { EmbedFilesChoice::kNeverEmbed, EmbedFilesChoice::kAlwaysEmbed, EmbedFilesChoice::kAskUser }
enum  ePreviewSceneType { preview_scene_server = 0, texture_2d_image = 1, force32_bit_sceneType = 0xFFFFFFFF }
enum  GDS_Flags : UINT_PTR {
  gds_Normal = 0x00000, gds_KindPrefix = 0x00001, gds_UppercasePropNames = 0x00002, gds_AbbreviatePropNames = 0x00004,
  gds_NameAndIdFirst = 0x00008, gds_ShortUuids = 0x00010, gds_SuppressDocumentId = 0x00020, gds_SuppressGroupId = 0x00040,
  gds_SuppressKind = 0x00080, gds_SuppressTags = 0x00100, gds_SuppressUsage = 0x00200, gds_SuppressSerialNumber = 0x00400,
  gds_SuppressCRCs = 0x00800, gds_SuppressChildSlotName = 0x01000, gds_SuppressRegistration = 0x02000, gds_SuppressAttributes = 0x04000,
  gds_SuppressCustomUserData = 0x08000, gds_SuppressTextureProxy = 0x10000
enum  Harvested : unsigned int { Harvested::None = 0, Harvested::Some = 1, Harvested::All = 2 }
enum  Kinds : unsigned int { Kinds::Unset, Kinds::Material, Kinds::Environment, Kinds::Texture }
enum  ParamSerialMethod : unsigned int { ParamSerialMethod::GetSet, ParamSerialMethod::XmlStream }
enum  ProxyTypes : unsigned int { ProxyTypes::None, ProxyTypes::Single, ProxyTypes::Multi, ProxyTypes::Texture }
enum  ReadParamsContext : unsigned int { ReadParamsContext::Serialization = 0, ReadParamsContext::Harvesting = 1, ReadParamsContext::Rendering = 2 }
enum  WriteParamsContext : unsigned int { WriteParamsContext::Serialization = 0, WriteParamsContext::Harvesting = 1, WriteParamsContext::Rendering = 2, WriteParamsContext::DragDrop = 3 }
- Public Types inherited from IAutoUIExtraRequirements
enum  SetContext : unsigned int { SetContext::UI, SetContext::Drop, SetContext::Program }

Public Member Functions

 CRhRdkCoreContent ()
 CRhRdkCoreContent (bool bAutoGlobalRegister)
virtual ~CRhRdkCoreContent ()
virtual RDK_DEPRECATED bool AddAutomaticUISection (const wchar_t *wszCaption, int id=0)
virtual bool AddAutomaticUISection (IRhRdkExpandableContentUI &ui, const wchar_t *wszLocalCaption, const wchar_t *wszEnglishCaption, int id=0)
virtual void AddUI (IRhRdkContentUI &ui) const override
virtual void AddUISections (IRhRdkExpandableContentUI &ui)
virtual RDK_DEPRECATED void AddUISections (void)
virtual bool CreatePreview (CRhRdkRenderPlugIn &plugIn, const ON_2iSize &sizeImage, RhRdkPreviewQuality qual, const IRhRdkPreviewSceneServer *pSceneServer, IRhRdkPreviewCallbacks *pNotify, CRhinoDib &dibOut) const override
virtual IRhRdkContentUICreateUI (IRhRdkContentEditor &e, const UUID &uuidUI, const CRhRdkContentArray &aInitialClients, void *pReserved) override
virtual IRhRdkCustomCurveGraphSectionCallbackCustomCurveGraphSectionCallback (void)
virtual void * EVF (const wchar_t *wszFunc, void *pvData) override
virtual void GetUIs (ON_SimpleArray< IRhRdkContentUI * > &aOut) const override
virtual CRhRdkPreviewBackgroundNewPreviewBackground (void) const override
virtual CRhRdkPreviewGeometryNewPreviewGeometry (void) const override
virtual ParamSerialMethod ParameterSerializationMethod (void) const override
virtual bool ReadParametersFromSection (const IRhRdk_XMLSection &section, ReadParamsContext context) override
virtual RDK_DEPRECATED bool RecreateTextureSummary (void)
virtual void ReleaseAllEditorUIs (const UUID &uuidEditor, bool bIncludeChildren) const override
virtual void ReleaseAllUIs (bool bIncludeChildren) const override
virtual void TransferUIsFrom (const CRhRdkContent &c) override
virtual RDK_DEPRECATED IRhRdkExpandableContentUIUI (void) const override
virtual bool WriteParametersToSection (IRhRdk_XMLSection &section, WriteParamsContext context) const override
- Public Member Functions inherited from CRhRdkContent
 CRhRdkContent ()
 CRhRdkContent (bool bAutoGlobalRegister)
virtual ~CRhRdkContent ()
virtual RDK_DEPRECATED void AddAutoParameters (class IRhRdkParamBlock &paramBlock, int id)
virtual void AddAutoParameters (class IRhRdkParamBlock &paramBlock, int id) const
virtual RDK_DEPRECATED bool AddChild (CRhRdkContent *pChild, const wchar_t *wszChildSlotName)
virtual bool AddToDocumentList (CRhRdkDocument &rdkDoc)
virtual const class IRhRdkPreviewAppearanceDefaults * AppearanceDefaults (void) const
virtual bool AttachCustomUserData (ICustomUserData *data)
virtual bool AutoDelete (void) const
virtual ON_wString AutomaticInstanceName (void) const
virtual CRhRdkContentBeginChange (RhRdkChangeContext cc) const
virtual unsigned int BitFlags (void) const
virtual bool CanBeEdited (void) const
virtual const wchar_t * Category (void) const =0
virtual bool ChangeChild (CRhRdkContent *pOldChild, CRhRdkContent *pNewChild)
virtual RDK_DEPRECATED void Changed (eChangeContext cc)
virtual void Changed (void)
bool CheckComplete (ON_wString &sReason) const
virtual RDK_DEPRECATED DWORD ChildrenRenderCRC (void) const
virtual CRhRdkVariant ChildSlotAmount (const wchar_t *wszChildSlotName) const
ON_wString ChildSlotDisplayName (void) const
virtual ON_wString ChildSlotName (void) const
virtual ON_wString ChildSlotNameFromParamName (const wchar_t *wszParamName) const
virtual CRhRdkVariant ChildSlotOn (const wchar_t *wszChildSlotName) const
CRhRdkContentClone (CopyMethods m=CopyMethods::Normal) const
void CommonCtor (bool b)
virtual bool ContentNameTakenFromFileName (void) const
virtual void ConvertMetersToUnits (void)
virtual void ConvertUnitsToMeters (void)
virtual bool CreatedByLoading (void) const
virtual RDK_DEPRECATED HBITMAP CreateLibraryPreview (const class CSize &sizeImage, const IRhRdkPreviewSceneServer *pSceneServer) const
virtual bool CreateLibraryPreview (const ON_2iSize &sizeImage, const IRhRdkPreviewSceneServer *pSceneServer, CRhinoDib &dibOut) const
virtual RDK_DEPRECATED HBITMAP CreatePreview (class CRhRdkRenderPlugIn &plugIn, const class CSize &sizeImage, eRhRdkRenderQuality qual, const class IRhRdkPreviewSceneServer *pSceneServer) const
virtual class IRhRdkContentUICreateUI (class IRhRdkContentEditor &e, const UUID &uuidUI, const class CRhRdkContentArray &aInitialClients, void *pReserved)=0
virtual const ICustomUserDataCustomUserData (const UUID &uuidDataId) const
virtual RDK_DEPRECATED void DecrementUseCount (void) const
virtual void DeleteAllChildren (void)
virtual bool DeleteChild (const wchar_t *wszChildSlotName)
virtual RDK_DEPRECATED void DestroyChildContent (const UUID &uuidPlugIn)
virtual void DestroyChildContent (const UUID &uuidPlugIn) const
virtual bool DetachCustomUserData (ICustomUserData *pUD)
virtual void DisplayContextHelp (HWND hwndParent) const
virtual void DisplayDebugString (const wchar_t *wszTitle=L"") const
ON_wString DisplayName (void) const
virtual RDK_DEPRECATED CRhinoDocDocument (void) const
CRhinoDocDocumentAssoc (void)
virtual const CRhinoDocDocumentAssoc (void) const
virtual ON_wString DragText (const UUID &uuidSource) const
ON_wString DragTextEx (const UUID &uuidSource, int version, void *) const
void Dump (const DumpContext &dc, unsigned int gds_flags, int indent=0) const
virtual const RDK_DEPRECATED CRhRdkContentDuplicate (void) const
const RDK_DEPRECATED CRhRdkContentDuplicateEx (bool reserved) const
const CRhRdkContentDuplicateEx (DupOpt d) const
virtual IAutoUIExtraRequirementsDuplicateExtraRequirementsInterface (void) const
virtual bool DuplicationInProgress (void) const
virtual bool DynamicIcon (const ON_2iSize &size, CRhinoDib &dibOut, DynamicIconUsage usage) const =0
virtual CRhRdkContentEdit (void) const
virtual ON_wString EmbeddedFiles (void) const
virtual ON_wString EmbeddedFilesRecursive (void) const
void EmergencyUnregister (void) const
virtual bool EndChange (void)
virtual void ExecuteCommand (UUID uuidCommand, void *pvData) const
virtual const CRhRdkContentFactoryFactory (void) const
virtual CRhRdkContentFastMakeCopy (CopyMethods m) const
class CRhRdkContentFieldsFields (void) const
virtual const CRhRdkContentFindChild (const wchar_t *wszChildSlotName) const
virtual const CRhRdkContentFindInstance (const UUID &uuidInstance) const
virtual RDK_DEPRECATED CRhRdkContentFindInstance (const wchar_t *wszName) const
virtual void FindInstanceByName (const wchar_t *wszName, bool bCaseSensitive, bool bRecurse, OUT CRhRdkContentArray &aContent) const
virtual const CRhRdkContentFirstChild (void) const
virtual const CRhRdkContentForDisplay (void) const
virtual void GetAutoParameters (const IRhRdkParamBlock &paramBlock, int id)
virtual RhRdkChangeContext GetChangeContext (void) const
virtual CChildIterator GetChildIterator (void) const
virtual ON_wString GetDebugString (const wchar_t *sep, UINT_PTR flags) const
virtual RDK_DEPRECATED bool GetDefaultsFromUser (HWND)
virtual bool GetDefaultsFromUser (void)
virtual ON_wString GetEnglishParamName (const wchar_t *wszParamName) const
virtual bool GetExtraRequirementParameter (const wchar_t *wszParamName, const wchar_t *wszExtraReqName, CRhRdkVariant &vValueOut) const
virtual void GetInstanceIdsRecursive (class CRhRdkInstanceIdArray &aOut) const
virtual ON_wString GetLocalizedParamName (const wchar_t *wszParamName) const
virtual CRhRdkVariant GetParameter (const wchar_t *wszName) const
virtual RDK_DEPRECATED bool GetParameters (const class IRhRdk_XMLSection &section, eGetParamsContext context)
virtual void * GetShader (const UUID &uuidRenderEngine, void *pvData) const
virtual bool GetSimulation (const IRhRdk_XMLSection &section)
void GetSortedChildren (OUT CRhRdkContentArray &aChild) const
bool GetUnderlyingInstances (OUT CRhRdkContentArray &a) const
virtual bool GlobalRegister (bool bRegister=true)
virtual const UUID & GroupId (void) const
virtual Harvested HarvestData (const CRhRdkContent &oldContent)=0
virtual bool Icon (const ON_2iSize &size, CRhinoDib &dibOut) const =0
virtual RDK_DEPRECATED HICON Icon (void) const
CImpl & Imp (void) const
virtual RDK_DEPRECATED void IncrementUseCount (void) const
virtual bool Initialize (void)
virtual const UUID & InstanceId (void) const
virtual ON_wString InstanceName (void) const
virtual void InternalChanged (RhRdkChangeContext, const CRhRdkContent *)
virtual ON_wString InternalName (void) const =0
virtual bool IsBasicType (void) const
virtual bool IsBuiltIn (void) const
bool IsChild (void) const
virtual bool IsCompatible (const UUID &uuidRenderEngine) const
virtual bool IsContentTypeAcceptableAsChild (const UUID &uuidType, const wchar_t *wszChildSlotName) const
virtual RDK_DEPRECATED bool IsCRCCached (void) const
virtual bool IsDefaultInstance (void) const
virtual bool IsFactoryProductAcceptableAsChild (const class CRhRdkContentFactory &f, const wchar_t *wszChildSlotName) const
virtual RDK_DEPRECATED bool IsFactoryProductAcceptableAsChild (const class CRhRdkContentFactory *pFactory, const wchar_t *wszChildSlotName) const
virtual bool IsHidden (void) const
virtual bool IsHiddenByAutoDelete (void) const
virtual RDK_DEPRECATED bool IsInDocument (void) const
virtual bool IsKind (CRhRdkContent::Kinds kind) const
virtual bool IsLocked (void) const
virtual bool IsOwnedByDocument (void) const
virtual bool IsPerObject (void) const
virtual bool IsPrivate (void) const
virtual bool IsReference (void) const
virtual bool IsRhinoObjectSelected (void) const
virtual bool IsSurrogate (void) const
virtual bool IsTopLevel (void) const
virtual bool IsUniversal (void) const
virtual bool IsV4Material (void) const
virtual Kinds Kind (void) const =0
virtual const wchar_t * LibraryFileExtension (void) const =0
virtual ON_wString LibraryFileName (void) const
virtual CRhRdkContentMakeCopy (CopyMethods m=CopyMethods::Normal) const
CRhRdkContentMakeCopyForPreview (void) const
virtual RDK_DEPRECATED CRhRdkContentMakeGroupInstance (void)
virtual CRhRdkContentMakeGroupInstance (void) const
virtual CChildSlotIteratorNewChildSlotIterator (CSIContext context) const
virtual class IRhRdkPreviewSceneServerNewPreviewSceneServer (const class CRhRdkSSData &data) const =0
virtual const CRhRdkContentNextSibling (void) const
virtual ON_wString Notes (void) const
virtual bool OnChildChanging (const CRhRdkContent *pOldChild, const CRhRdkContent *pNewChild) const
virtual bool OnChildSlotChanged (const wchar_t *wszChildSlotName) const
virtual bool OnChildSlotChanging (const wchar_t *wszChildSlotName) const
virtual void OnDocumentRegister (void) const
virtual void OnDocumentUnregister (void) const
virtual bool OnExtraRequirementButtonClicked (const wchar_t *wszParamName, const wchar_t *wszButtonName)
virtual void OnFieldChanged (const class CRhRdkContentField &field, const CRhRdkVariant &vOldValue, RhRdkChangeContext cc, void *pReserved)
bool OpenInFirstMainModelessEditor (void) const
virtual bool OpenInMainEditor (void) const
virtual RDK_DEPRECATED bool OpenInModalEditor (UINT uFlags=0)
virtual ON_wString ParamNameFromChildSlotName (const wchar_t *wszChildSlotName) const
virtual const CRhRdkContentParent (void) const
virtual UUID PlugInId (void) const =0
virtual UINT PreviewBackgroundFlags (void) const =0
virtual UINT PreviewGeometryFlags (void) const =0
virtual UINT PreviewLightingFlags (void) const =0
virtual ePreviewSceneType PreviewSceneType (void) const =0
virtual int PreviewUpdateDelay (void) const
void Promote (void)
virtual ProxyTypes ProxyType (void) const
virtual const CRhRdkDocumentRdkDocumentAssoc (void) const
virtual UUID RdkDocumentId (void) const
virtual const CRhRdkDocumentRdkDocumentOwner (void) const
virtual const RDK_DEPRECATED CRhRdkDocumentRdkDocumentRegistered (void) const
virtual RDK_DEPRECATED bool ReadParameterXMLStream (const wchar_t *wszStream, eGetParamsContext context)
virtual bool ReadParameterXMLStream (const wchar_t *wszStream, ReadParamsContext context)
virtual bool ReadSimulationXMLStream (wchar_t *wszStream)
RDK_DEPRECATED bool ReadXMLStream (const wchar_t *wszStream)
virtual bool ReadXMLStream (const wchar_t *wszStream, const CRhinoFileReadOptions *pOptions)
virtual bool RemoveFromDocumentList (CRhRdkDocument &rdkDoc)
virtual bool RemoveRdkDocumentAssoc (void)
virtual unsigned int RenderCRC (const CRenderCRCFlags &rcrcFlags) const
RDK_DEPRECATED unsigned int RenderCRC (const CRenderCRCFlags &rcrcFlags, const IRhRdkLinearWorkflow &lw) const
unsigned int RenderCRC (const CRenderCRCFlags &rcrcFlags, const ON_LinearWorkflow &lw) const
virtual UUID RenderEngineId (void) const =0
virtual void ResetParametersToDefaults (const ON_ClassArray< ON_wString > &aParams)
virtual RDK_DEPRECATED void ResetUseCount (void) const
virtual void ResolveRelativePaths (const wchar_t *wszPathToFile)
virtual void ResolveURLPaths (bool bForceDownload=false)
ON_wString SavedCSN (void) const
virtual RDK_DEPRECATED bool SaveToLibraryFile (const ON_wString &sFullPath, const IRhRdkPreviewSceneServer *pSceneServer) const
virtual bool SaveToLibraryFile (const ON_wString &sFullPath, const IRhRdkPreviewSceneServer *pSceneServer, EmbedFilesChoice c) const
virtual bool SaveToLibraryFile_Internal (const wchar_t *wszFullPath, const IRhRdkPreviewSceneServer *pSceneServer, bool bEmbedFiles) const
virtual void SetAutoDelete (bool bAutoDelete)
virtual bool SetChild (const CRhRdkContent *pChild, const wchar_t *wszChildSlotName)
virtual bool SetChildSlotAmount (const wchar_t *wszChildSlotName, double dPercent)
virtual void SetChildSlotName (const wchar_t *wszChildSlotName)
virtual bool SetChildSlotOn (const wchar_t *wszChildSlotName, bool bOn)
virtual RDK_DEPRECATED void SetCRCCache (DWORD dwCRC) const
virtual bool SetDocumentAssoc (const CRhinoDoc &doc) const
bool SetDocumentAssoc (const CRhRdkContent &) const
virtual bool SetExtraRequirementParameter (const wchar_t *wszParamName, const wchar_t *wszExtraReqName, const CRhRdkVariant &vValue, SetContext sc)
virtual void SetGroupId (const UUID &uuidGroup) const
virtual void SetHidden (bool bHidden)
RDK_DEPRECATED void SetHidden (bool bHidden, eChangeContext cc)
virtual void SetInstanceId (UUID uuidInstance)
virtual void SetInstanceName (const wchar_t *wszName)
void SetInstanceName (const wchar_t *wszName, bool bRenameEvents, bool bEnsureNameUnique)
virtual void SetInstanceNameImpl (const wchar_t *wszName, bool bRenameEvents)
void SetInstanceNameImpl (const wchar_t *wszName, bool bRenameEvents, bool bEnsureNameUnique)
virtual RDK_DEPRECATED void SetIsReference (bool b)
void SetIsRenderCRCRecursive (bool bRecursive)
virtual void SetIsRhinoObjectSelected (bool bSelected) const
virtual void SetLocked (void)
virtual void SetNotes (const wchar_t *wszNotes)
RDK_DEPRECATED void SetNotes (const wchar_t *wszNotes, bool bSendEvents)
virtual bool SetParameter (const wchar_t *wszName, const CRhRdkVariant &vValue)
virtual RDK_DEPRECATED bool SetParameter (const wchar_t *wszName, const CRhRdkVariant &vValue, eChangeContext cc)
virtual RDK_DEPRECATED bool SetParameters (class IRhRdk_XMLSection &section, eSetParamsContext context) const
virtual bool SetRdkDocumentAssoc (const CRhRdkDocument &rdkDoc)
virtual bool SetRdkDocumentOwner (CRhRdkDocument *pRdkDoc)
virtual bool SetSimulation (IRhRdk_XMLSection &section) const
virtual void SetTags (const wchar_t *wszTags, bool bSendEvents=true)
virtual bool SmartUngroupRecursive (void)
virtual bool SupportsCommand (UUID uuidCommand) const
virtual bool SupportsContextHelp (void) const
virtual ON_wString Tags (void) const
ON_RenderContentToON_RenderContent (bool bRecursive=true) const
virtual CRhRdkContentTopLevel (void)
virtual const CRhRdkContentTopLevel (void) const
virtual CRhRdkContentTopLevelParent (void)
virtual const CRhRdkContentTopLevelParent (void) const
virtual ON_wString TypeDescription (void) const =0
virtual UUID TypeId (void) const =0
virtual ON_wString TypeName (void) const =0
virtual RDK_DEPRECATED bool Ungroup (void)
virtual bool Ungroup (void) const
virtual RDK_DEPRECATED bool UngroupRecursive (void)
virtual bool UngroupRecursive (void) const
virtual void Uninitialize (void)
virtual bool UpdateDocumentTables (void) const =0
virtual void UpdatePreview (void) const
virtual RDK_DEPRECATED void UpdateUI (void) const
virtual int UseCount (void) const
virtual void VerifyCopy (const CRhRdkContent *pCopy) const
virtual RDK_DEPRECATED const class IRhRdkThumbViewDefaults * ViewDefaults (void) const
virtual RDK_DEPRECATED DWORD WriteParameterXMLStream (wchar_t *wszStream, DWORD dwMaxChars, eSetParamsContext context) const
virtual size_t WriteParameterXMLStream (wchar_t *wszStream, size_t maxChars, WriteParamsContext context) const
virtual size_t WriteSimulationXMLStream (wchar_t *wszStream, size_t maxChars) const
virtual RDK_DEPRECATED DWORD WriteXMLStream (wchar_t *wszStream, DWORD dwMaxChars, eSetParamsContext context) const
virtual size_t WriteXMLStream (wchar_t *wszStream, size_t maxChars, WriteParamsContext context, const CRhinoFileWriteOptions *pOptions) const
- Public Member Functions inherited from CRhRdkObject
 CRhRdkObject ()
virtual ~CRhRdkObject ()
void operator delete (void *buf)
void operator delete[] (void *buf)
void * operator new (size_t size)
void * operator new[] (size_t size)
- Public Member Functions inherited from IAutoUIExtraRequirements
virtual ~IAutoUIExtraRequirements ()

Additional Inherited Members

- Static Public Member Functions inherited from CRhRdkContent
static RhRdkChangeContext ChangeContextFromSetContext (SetContext sc)
static RDK_DEPRECATED CRhRdkContentCreateObjectFromType (UUID uuidType)
static CRhRdkContentFromON_RenderContent (const class ON_RenderContent &rc, const CRhinoDoc *pDocAssoc, bool bRecursive)
static RDK_DEPRECATED CRhRdkContentFromXMLStream (const wchar_t *wszXML)
static RDK_DEPRECATED CRhRdkContentFromXMLStream (const wchar_t *wszXML, const CRhinoDoc *pDocAssoc)
static CRhRdkContentFromXMLStream (const wchar_t *wszXML, const CRhinoDoc *pDocAssoc, bool bUseXMLInstanceId)
static bool IsChangeContextUIBased (RhRdkChangeContext cc)
static SetContext SetContextFromChangeContext (RhRdkChangeContext cc)
static void UninitializeAndDelete (CRhRdkContent *pContent)
- Static Public Member Functions inherited from CRhRdkObject
static void CheckMemory (void)
static void PopulateDebuggingInfo (void)
- Protected Member Functions inherited from CRhRdkContent
virtual unsigned int ComputeRenderCRC (const CRenderCRCFlags &rcrcFlags) const

Detailed Description

This class provides a default implementation of user interface creation and destruction. To use this, derive your content from CRhRdkCoreContent instead of CRhRdkContent and override AddUISections() to add each of your user interface sections (derived from CRhRdkContentUISection_MFC).

Member Enumeration Documentation

◆ SectionId

See also

This id value is used when creating the Texture Summary section. AddAutoParameters() and GetAutoParameters() will be called with this id value if that section is included in your UI.


This id value is used to indicate that the section id parameter is not used.

Constructor & Destructor Documentation

◆ CRhRdkCoreContent() [1/2]

CRhRdkCoreContent::CRhRdkCoreContent ( )

◆ CRhRdkCoreContent() [2/2]

CRhRdkCoreContent::CRhRdkCoreContent ( bool  bAutoGlobalRegister)

◆ ~CRhRdkCoreContent()

virtual CRhRdkCoreContent::~CRhRdkCoreContent ( )

Member Function Documentation

◆ AddAutomaticUISection() [1/2]

virtual RDK_DEPRECATED bool CRhRdkCoreContent::AddAutomaticUISection ( const wchar_t *  wszCaption,
int  id = 0 

This method is deprecated in favor of the one below.

◆ AddAutomaticUISection() [2/2]

virtual bool CRhRdkCoreContent::AddAutomaticUISection ( IRhRdkExpandableContentUI ui,
const wchar_t *  wszLocalCaption,
const wchar_t *  wszEnglishCaption,
int  id = 0 

Call this method from AddUISections() in order to add an automatic section. You will need to override AddAutoParameters() to add the parameters to a collection that will be used by this system.

uiis the UI to add the automatic section to.
wszLocalCaptionis the localized caption to display in the section header.
wszEnglishCaptionis the english caption.
idis a caller-defined identifier (can be zero if not needed). Values of 0x8000 and above are reserved for RDK internal use.
See also
enum eSectionId for special values used internally.
This method must only be called from AddUISections().
See also
true if successful, else false.

◆ AddUI()

virtual void CRhRdkCoreContent::AddUI ( IRhRdkContentUI ui) const

Implements CRhRdkContent.

◆ AddUISections() [1/2]

virtual void CRhRdkCoreContent::AddUISections ( IRhRdkExpandableContentUI ui)

This is called by the default implementation of CreateUI. You should create each of your UI sections using 'new' and then call ui.AddSection() on them. Please be sure to call the base class after adding your sections.

Reimplemented in CRhRdkTwoColorTextureBase, and CRhRdkTexture.

◆ AddUISections() [2/2]

virtual RDK_DEPRECATED void CRhRdkCoreContent::AddUISections ( void  )

This method is deprecated in favor of the one below.

Reimplemented in CRhRdkTexture.

◆ CreatePreview()

virtual bool CRhRdkCoreContent::CreatePreview ( CRhRdkRenderPlugIn plugIn,
const ON_2iSize sizeImage,
RhRdkPreviewQuality  qual,
const IRhRdkPreviewSceneServer pSceneServer,
IRhRdkPreviewCallbacks pNotify,
CRhinoDib dibOut 
) const

Create a preview of the content for use in the content editor thumbnail display.

plugInThe render plug-in to use to render the preview.
sizeImageThe size of the image to render.
qualThe quality of the preview.
pSceneServerA pointer to a scene server that defines the scene for the preview rendering. This can be null in which case a default scene is used.
dibOutA dib containing the rendered image if the method returns true.
true if successful, else false.

Implements CRhRdkContent.

Reimplemented in CRhRdkTexture.

◆ CreateUI()

virtual IRhRdkContentUI* CRhRdkCoreContent::CreateUI ( IRhRdkContentEditor e,
const UUID &  uuidUI,
const CRhRdkContentArray aInitialClients,
void *  pReserved 

Used by the RDK editor to create the content's UI. This UI allows editing of the content's persistent state. In order to reduce the number of Window handles used by content UIs, RDK supports Content UI Sharing. This causes your content UI to be shared with other contents of the same type id. Your UI code cannot store the pointer, reference or instance id of the associated content because that content will change when the selection changes. The default implementation creates a UI using a 'holder' and 'sections' (AKA 'roll-ups'). You can override this method to completely replace the RDK's default content UI system for this particular content type. This is an expert override which will break the RDK content editor if implemented incorrectly.

See also
eis the editor the UI will appear in.
uuidUIis the unique identifier of the UI being created.
aInitialClientsis an array of contents that are requesting the UI to be created.
pReservedis reserved for future use.
true if successful, else false.

◆ CustomCurveGraphSectionCallback()

virtual IRhRdkCustomCurveGraphSectionCallback* CRhRdkCoreContent::CustomCurveGraphSectionCallback ( void  )

Optionally implement this method to have RDK add a custom curve section to your content's UI. The custom curve section will be identified by the UUID uuidCustomCurveSection in RhRdkUuids.h

See also
A pointer to a new instance of your implementation of IRhRdkCustomCurveGraphSectionSharedCallback. The callback object will be owned by the UI section. The default implementation returns null; no custom curve section required.

[SDK_UNFREEZE] Prefix this function name with 'New', make it const, and return IRhRdkCustomCurveGraphSectionSharedCallback.

The return type of this method is wrong; it is the obsolete IRhRdkCustomCurveGraphSectionCallback interface. Until we can fix this properly you must use reinterpret_cast to return a new instance of your implementation of IRhRdkCustomCurveGraphSectionSharedCallback as IRhRdkCustomCurveGraphSectionCallback.

IRhRdkCustomCurveGraphSectionCallback* CMyMaterial::CustomCurveGraphSectionCallback(void) { return reinterpret_cast<IRhRdkCustomCurveGraphSectionCallback*>(new CMyCurveCallback); }

◆ EVF()

virtual void* CRhRdkCoreContent::EVF ( const wchar_t *  wszFunc,
void *  pvData 

Emergency virtual function for future expansion.

Reimplemented from CRhRdkContent.

Reimplemented in CRhRdkTexture, CRhRdkMaterial, and CRhRdkEnvironment.

◆ GetUIs()

virtual void CRhRdkCoreContent::GetUIs ( ON_SimpleArray< IRhRdkContentUI * > &  aOut) const

Get an array of pointers to UIs that the content is a client of.

Implements CRhRdkContent.

◆ NewPreviewBackground()

virtual CRhRdkPreviewBackground* CRhRdkCoreContent::NewPreviewBackground ( void  ) const

Implements CRhRdkContent.

Reimplemented in CRhRdkTexture, CRhRdkMaterial, and CRhRdkEnvironment.

◆ NewPreviewGeometry()

virtual CRhRdkPreviewGeometry* CRhRdkCoreContent::NewPreviewGeometry ( void  ) const

Implements CRhRdkContent.

Reimplemented in CRhRdkTexture, CRhRdkMaterial, and CRhRdkEnvironment.

◆ ParameterSerializationMethod()

virtual ParamSerialMethod CRhRdkCoreContent::ParameterSerializationMethod ( void  ) const

Implement this method to indicate which serialization method your content uses. If you return GetSet then you must implement the ReadParametersFromSection() and WriteParametersToSection() methods to serialize the parameters. If you return XmlStream then you must implement the low-level ReadParameterXMLStream() and WriteParameterXMLStream() methods to serialize the parameters.

Using GetSet is the easiest and preferred way to serialize the parameters, and it is required if you want your content to animate in Bongo 2.

Implements CRhRdkContent.

Reimplemented in CRhRdkBasicMaterial, and CRhRdkTexture.

◆ ReadParametersFromSection()

virtual bool CRhRdkCoreContent::ReadParametersFromSection ( const IRhRdk_XMLSection section,
ReadParamsContext  context 

Please be sure to call the base class if you override this function.

Reimplemented from CRhRdkContent.

Reimplemented in CRhRdkBasicMaterial, CRhRdkTwoColorTextureBase, CRhRdkOneColorTextureBase, and CRhRdkTexture.

◆ RecreateTextureSummary()

virtual RDK_DEPRECATED bool CRhRdkCoreContent::RecreateTextureSummary ( void  )

This method is obsolete because the Texture Summary panel now automatically refreshes as necessary.

◆ ReleaseAllEditorUIs()

virtual void CRhRdkCoreContent::ReleaseAllEditorUIs ( const UUID &  uuidEditor,
bool  bIncludeChildren 
) const

For expert use only. You should never need to override this method.

Implements CRhRdkContent.

◆ ReleaseAllUIs()

virtual void CRhRdkCoreContent::ReleaseAllUIs ( bool  bIncludeChildren) const

For expert use only. You should never need to override this method.

Implements CRhRdkContent.

◆ TransferUIsFrom()

virtual void CRhRdkCoreContent::TransferUIsFrom ( const CRhRdkContent c)

Implements CRhRdkContent.

◆ UI()

virtual RDK_DEPRECATED IRhRdkExpandableContentUI* CRhRdkCoreContent::UI ( void  ) const

This method is deprecated in favor of the one below.

Implements CRhRdkContent.

◆ WriteParametersToSection()

virtual bool CRhRdkCoreContent::WriteParametersToSection ( IRhRdk_XMLSection section,
WriteParamsContext  context 
) const

Please be sure to call the base class if you override this function.

Reimplemented from CRhRdkContent.

Reimplemented in CRhRdkBasicMaterial, CRhRdkTwoColorTextureBase, CRhRdkOneColorTextureBase, and CRhRdkTexture.