#include <RhRdkEnvironment.h>

Inheritance diagram for CRhRdkEnvironment:

Public Types
enum	ChildSlotUsage : unsigned int { ChildSlotUsage::Background = 0x01, ChildSlotUsage::Reflection = 0x02, ChildSlotUsage::Skylighting = 0x04, ChildSlotUsage::Any = Background \| Reflection \| Skylighting }

Public Types inherited from CRhRdkCoreContent
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	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
	CRhRdkEnvironment ()

virtual	~CRhRdkEnvironment ()

RDK_DEPRECATED ON_wString	BackgroundTextureChildSlotName (void) const

virtual const wchar_t *	Category (void) const override

virtual bool	DynamicIcon (const ON_2iSize &size, CRhinoDib &dibOut, DynamicIconUsage usage) const override

virtual void *	EVF (const wchar_t wszFunc, void pvData) override

virtual bool	GetTextureChannelInfo (ChildSlotUsage usage, TextureChannelInfo &info) const

const CRhRdkContent *	GetTextureForUsage (ChildSlotUsage) const

virtual Harvested	HarvestData (const CRhRdkContent &oldContent) override

virtual bool	Icon (const ON_2iSize &size, CRhinoDib &dibOut) const override

virtual bool	IsInUse (IRhRdkCurrentEnvironment::Usage usage) const

virtual Kinds	Kind (void) const final override

virtual const wchar_t *	LibraryFileExtension (void) const override

virtual IRhRdkPreviewSceneServer *	NewPreviewSceneServer (const CRhRdkSSData &data) const override

virtual ePreviewSceneType	PreviewSceneType (void) const override

virtual RDK_DEPRECATED void	SimulateEnvironment (CRhRdkSimulatedEnvironment &env, bool bForDataOnly) const

virtual void	SimulateEnvironment (CRhRdkSimulatedEnvironment &env, CRhRdkTexture::TextureGeneration tg=CRhRdkTexture::TextureGeneration::Allow, int iSimulatedTextureSize=-1) const =0

RDK_DEPRECATED ON_wString	SkylightingTextureChildSlotName (void) const

virtual ON_wString	TextureChildSlotName (ChildSlotUsage usage) const

virtual bool	UpdateDocumentTables (void) const override

Public Member Functions inherited from CRhRdkCoreContent
	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 IRhRdkContentUI *	CreateUI (IRhRdkContentEditor &e, const UUID &uuidUI, const CRhRdkContentArray &aInitialClients, void *pReserved) override

virtual IRhRdkCustomCurveGraphSectionCallback *	CustomCurveGraphSectionCallback (void)

virtual void	GetUIs (ON_SimpleArray< IRhRdkContentUI * > &aOut) 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 IRhRdkExpandableContentUI *	UI (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 CRhRdkContent &	BeginChange (RhRdkChangeContext cc) const

virtual unsigned int	BitFlags (void) const

virtual bool	CanBeEdited (void) const

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

CRhRdkContent *	Clone (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 IRhRdkContentUI *	CreateUI (class IRhRdkContentEditor &e, const UUID &uuidUI, const class CRhRdkContentArray &aInitialClients, void *pReserved)=0

virtual const ICustomUserData *	CustomUserData (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 CRhinoDoc *	Document (void) const

CRhinoDoc *	DocumentAssoc (void)

virtual const CRhinoDoc *	DocumentAssoc (void) const

virtual ON_wString	DragText (const UUID &uuidSource) const

ON_wString	DragTextEx (const UUID &uuidSource, int version, void *) const

virtual const RDK_DEPRECATED CRhRdkContent *	Duplicate (void) const

const RDK_DEPRECATED CRhRdkContent *	DuplicateEx (bool reserved) const

const CRhRdkContent *	DuplicateEx (DupOpt d) const

virtual IAutoUIExtraRequirements *	DuplicateExtraRequirementsInterface (void) const

virtual bool	DuplicationInProgress (void) const

virtual CRhRdkContent *	Edit (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 CRhRdkContentFactory *	Factory (void) const

virtual CRhRdkContent *	FastMakeCopy (CopyMethods m) const

class CRhRdkContentFields &	Fields (void) const

virtual const CRhRdkContent *	FindChild (const wchar_t *wszChildSlotName) const

virtual const CRhRdkContent *	FindInstance (const UUID &uuidInstance) const

virtual RDK_DEPRECATED CRhRdkContent *	FindInstance (const wchar_t *wszName) const

virtual void	FindInstanceByName (const wchar_t *wszName, bool bCaseSensitive, bool bRecurse, OUT CRhRdkContentArray &aContent) const

virtual const CRhRdkContent *	FirstChild (void) const

virtual const CRhRdkContent *	ForDisplay (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 *wszSeparator, UINT_PTR reserved) 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 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 ON_wString	LibraryFileName (void) const

virtual CRhRdkContent *	MakeCopy (CopyMethods m=CopyMethods::Normal) const

virtual RDK_DEPRECATED CRhRdkContent *	MakeGroupInstance (void)

virtual CRhRdkContent *	MakeGroupInstance (void) const

virtual CChildSlotIterator *	NewChildSlotIterator (CSIContext context) const

virtual class IRhRdkPreviewSceneServer *	NewPreviewSceneServer (const class CRhRdkSSData &data) const =0

virtual const CRhRdkContent *	NextSibling (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 CRhRdkContent *	Parent (void) const

virtual UUID	PlugInId (void) const =0

virtual int	PreviewUpdateDelay (void) const

void	Promote (void)

virtual ProxyTypes	ProxyType (void) const

virtual const CRhRdkDocument *	RdkDocumentAssoc (void) const

virtual UUID	RdkDocumentId (void) const

virtual const CRhRdkDocument *	RdkDocumentOwner (void) const

virtual const RDK_DEPRECATED CRhRdkDocument *	RdkDocumentRegistered (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 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_RenderContent *	ToON_RenderContent (bool bRecursive=true) const

virtual CRhRdkContent &	TopLevel (void)

virtual const CRhRdkContent &	TopLevel (void) const

virtual CRhRdkContent *	TopLevelParent (void)

virtual const CRhRdkContent *	TopLevelParent (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 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 ()

Static Public Member Functions
static bool	ComputeBoxUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeCubemapUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeEmapUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeHemisphericalUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeHorizontalCrossCubemapUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeLightprobeUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeProjectionUV (CRhRdkSimulatedEnvironment::BackgroundProjections, const ON_3dVector &v, float &a, float &b)

static bool	ComputeSphereUV (const ON_3dVector &v, float &a, float &b)

static bool	ComputeVerticalCrossCubemapUV (const ON_3dVector &v, float &a, float &b)

Static Public Member Functions inherited from CRhRdkContent
static RhRdkChangeContext	ChangeContextFromSetContext (SetContext sc)

static RDK_DEPRECATED CRhRdkContent *	CreateObjectFromType (UUID uuidType)

static CRhRdkContent *	FromON_RenderContent (const class ON_RenderContent &rc, const CRhinoDoc *pDocAssoc, bool bRecursive)

static RDK_DEPRECATED CRhRdkContent *	FromXMLStream (const wchar_t *wszXML)

static RDK_DEPRECATED CRhRdkContent *	FromXMLStream (const wchar_t wszXML, const CRhinoDoc pDocAssoc)

static CRhRdkContent *	FromXMLStream (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
virtual CRhRdkPreviewBackground *	NewPreviewBackground (void) const override

virtual CRhRdkPreviewGeometry *	NewPreviewGeometry (void) const override

virtual UINT	PreviewBackgroundFlags (void) const override

virtual UINT	PreviewGeometryFlags (void) const override

virtual UINT	PreviewLightingFlags (void) const override

virtual bool	SetSimulation (IRhRdk_XMLSection &section) const override

Protected Member Functions inherited from CRhRdkContent
virtual unsigned int	ComputeRenderCRC (const CRenderCRCFlags &rcrcFlags) const

Detailed Description

This is an abstract base class for all kinds of environments.

Member Enumeration Documentation

◆ ChildSlotUsage

enum CRhRdkEnvironment::ChildSlotUsage : unsigned int

strong

Enumerator
Background
Reflection
Skylighting
Any

Constructor & Destructor Documentation

◆ CRhRdkEnvironment()

CRhRdkEnvironment::CRhRdkEnvironment ( )

◆ ~CRhRdkEnvironment()

virtual CRhRdkEnvironment::~CRhRdkEnvironment ( )

virtual

Member Function Documentation

◆ BackgroundTextureChildSlotName()

RDK_DEPRECATED ON_wString CRhRdkEnvironment::BackgroundTextureChildSlotName ( void ) const

This method is deprecated in favor of TextureChildSlotName().

◆ Category()

virtual const wchar_t* CRhRdkEnvironment::Category ( void ) const

inlineoverridevirtual

Returns: The category of the content.

Implements CRhRdkContent.

◆ ComputeBoxUV()

static bool CRhRdkEnvironment::ComputeBoxUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeCubemapUV()

static bool CRhRdkEnvironment::ComputeCubemapUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeEmapUV()

static bool CRhRdkEnvironment::ComputeEmapUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeHemisphericalUV()

static bool CRhRdkEnvironment::ComputeHemisphericalUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeHorizontalCrossCubemapUV()

static bool CRhRdkEnvironment::ComputeHorizontalCrossCubemapUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeLightprobeUV()

static bool CRhRdkEnvironment::ComputeLightprobeUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeProjectionUV()

static bool CRhRdkEnvironment::ComputeProjectionUV	(	CRhRdkSimulatedEnvironment::BackgroundProjections	,
		const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeSphereUV()

static bool CRhRdkEnvironment::ComputeSphereUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ ComputeVerticalCrossCubemapUV()

static bool CRhRdkEnvironment::ComputeVerticalCrossCubemapUV	(	const ON_3dVector &	v,
		float &	a,
		float &	b
	)

static

◆ DynamicIcon()

virtual bool CRhRdkEnvironment::DynamicIcon	(	const ON_2iSize &	size,
		CRhinoDib &	dibOut,
		DynamicIconUsage	usage
	)		const

overridevirtual

Creates imagery (AKA an 'icon') to represent the content's appearance. This imagery is dynamic, i.e., it changes depending on the content's state (parameters). It is similar to a quick preview and may be implemented in a similar way to CreatePreview().

Parameters

size	is the desired physical size of the imagery, in pixels.
dibOut	is a DIB that accepts the created imagery.
usage	specifies how the icon will be used.

Returns: true if successful, else false.

Implements CRhRdkContent.

◆ EVF()

virtual void* CRhRdkEnvironment::EVF	(	const wchar_t *	wszFunc,
		void *	pvData
	)

overridevirtual

Emergency virtual function for future expansion.

Reimplemented from CRhRdkCoreContent.

◆ GetTextureChannelInfo()

virtual bool CRhRdkEnvironment::GetTextureChannelInfo	(	ChildSlotUsage	usage,
		TextureChannelInfo &	info
	)		const

virtual

Used by the framework instead of TextureChildSlotName() when simply asking for the texture. The default implementation calls TextureChildSlotName().

◆ GetTextureForUsage()

const CRhRdkContent* CRhRdkEnvironment::GetTextureForUsage ( ChildSlotUsage ) const

Helper function- implemened using GetTextureChannelInfo.

◆ HarvestData()

virtual Harvested CRhRdkEnvironment::HarvestData ( const CRhRdkContent & oldContent )

overridevirtual

Implement this to transfer data from another content to this content during creation.

Parameters

oldContent is an old content from which the implementation may harvest data.

Implements CRhRdkContent.

◆ Icon()

virtual bool CRhRdkEnvironment::Icon	(	const ON_2iSize &	size,
		CRhinoDib &	dibOut
	)		const

overridevirtual

Creates imagery (AKA an 'icon') to represent the content's type. This imagery is static, i.e., it does not change.

Parameters

size	is the desired physical size of the imagery, in pixels.
dibOut	is a DIB that accepts the created imagery.

Returns: true if successful, else false.

Implements CRhRdkContent.

◆ IsInUse()

virtual bool CRhRdkEnvironment::IsInUse ( IRhRdkCurrentEnvironment::Usage usage ) const

virtual

Returns: true if this environment is in a document and is the current environment for a particular usage in that document.

◆ Kind()

virtual Kinds CRhRdkEnvironment::Kind ( void ) const

finaloverridevirtual

Returns: The kind of the content.

Implements CRhRdkContent.

◆ LibraryFileExtension()

virtual const wchar_t* CRhRdkEnvironment::LibraryFileExtension ( void ) const

overridevirtual

Returns: A pointer to a fixed string giving the library file extension of the content.

Implements CRhRdkContent.

◆ NewPreviewBackground()

virtual CRhRdkPreviewBackground* CRhRdkEnvironment::NewPreviewBackground ( void ) const

overrideprotectedvirtual

Reimplemented from CRhRdkCoreContent.

◆ NewPreviewGeometry()

virtual CRhRdkPreviewGeometry* CRhRdkEnvironment::NewPreviewGeometry ( void ) const

overrideprotectedvirtual

Reimplemented from CRhRdkCoreContent.

◆ NewPreviewSceneServer()

virtual IRhRdkPreviewSceneServer* CRhRdkEnvironment::NewPreviewSceneServer ( const CRhRdkSSData & data ) const

overridevirtual

◆ PreviewBackgroundFlags()

virtual UINT CRhRdkEnvironment::PreviewBackgroundFlags ( void ) const

overrideprotectedvirtual

Returns: Bit-flags denoting supported preview background types.

Implements CRhRdkContent.

◆ PreviewGeometryFlags()

virtual UINT CRhRdkEnvironment::PreviewGeometryFlags ( void ) const

overrideprotectedvirtual

Returns: Bit-flags denoting supported preview geometry types.

Implements CRhRdkContent.

◆ PreviewLightingFlags()

virtual UINT CRhRdkEnvironment::PreviewLightingFlags ( void ) const

overrideprotectedvirtual

Returns: Bit-flags denoting supported preview lighting types.

Implements CRhRdkContent.

◆ PreviewSceneType()

virtual ePreviewSceneType CRhRdkEnvironment::PreviewSceneType ( void ) const

inlineoverridevirtual

This is an advanced method which you can override in exceptional circumstances.

Returns: texture_2d_image if you want RDK to produce a texture preview from the texture evaluator or preview_scene_server to cause RDK to call NewPreviewSceneServer().

Implements CRhRdkContent.

◆ SetSimulation()

virtual bool CRhRdkEnvironment::SetSimulation ( IRhRdk_XMLSection & section ) const

overrideprotectedvirtual

Optionally override this method to add the content's simulation to an XML section. This is needed if you want to avoid having to use WriteSimulationXMLStream() for serialization. For this to work you must return true. The default implementation is a no-op that returns false. This is the easiest and preferred way to serialize the simulation.

Reimplemented from CRhRdkContent.

◆ SimulateEnvironment() [1/2]

virtual RDK_DEPRECATED void CRhRdkEnvironment::SimulateEnvironment	(	CRhRdkSimulatedEnvironment &	env,
		bool	bForDataOnly
	)		const

virtual

This method is deprecated in favor of the one below. bForDataOnly becomes true=CRhRdkTexture::TextureGeneration::Disallow, false=CRhRdkTexture::TextureGeneration::Allow

◆ SimulateEnvironment() [2/2]

virtual void CRhRdkEnvironment::SimulateEnvironment	(	CRhRdkSimulatedEnvironment &	env,
		CRhRdkTexture::TextureGeneration	tg = `CRhRdkTexture::TextureGeneration::Allow`,
		int	iSimulatedTextureSize = `-1`
	)		const

pure virtual

Modify a CRhRdkSimulatedEnvironment to simulate this environment as best you can.

◆ SkylightingTextureChildSlotName()

RDK_DEPRECATED ON_wString CRhRdkEnvironment::SkylightingTextureChildSlotName ( void ) const

This method is deprecated in favor of TextureChildSlotName().

◆ TextureChildSlotName()

virtual ON_wString CRhRdkEnvironment::TextureChildSlotName ( ChildSlotUsage usage ) const

virtual

Returns: the texture child slot name for a particular usage.

Parameters

usage specifies the usage for which the child slot name is required.

◆ UpdateDocumentTables()

virtual bool CRhRdkEnvironment::UpdateDocumentTables ( void ) const

overridevirtual

Called by Changed() to update Rhino document tables.

Returns: true if successful, else false.

Implements CRhRdkContent.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ ChildSlotUsage

Constructor & Destructor Documentation

◆ CRhRdkEnvironment()

◆ ~CRhRdkEnvironment()

Member Function Documentation

◆ BackgroundTextureChildSlotName()

◆ Category()

◆ ComputeBoxUV()

◆ ComputeCubemapUV()

◆ ComputeEmapUV()

◆ ComputeHemisphericalUV()

◆ ComputeHorizontalCrossCubemapUV()

◆ ComputeLightprobeUV()

◆ ComputeProjectionUV()

◆ ComputeSphereUV()

◆ ComputeVerticalCrossCubemapUV()

◆ DynamicIcon()

◆ EVF()

◆ GetTextureChannelInfo()

◆ GetTextureForUsage()

◆ HarvestData()

◆ Icon()

◆ IsInUse()

◆ Kind()

◆ LibraryFileExtension()

◆ NewPreviewBackground()

◆ NewPreviewGeometry()

◆ NewPreviewSceneServer()

◆ PreviewBackgroundFlags()

◆ PreviewGeometryFlags()

◆ PreviewLightingFlags()

◆ PreviewSceneType()

◆ SetSimulation()

◆ SimulateEnvironment() [1/2]

◆ SimulateEnvironment() [2/2]

◆ SkylightingTextureChildSlotName()

◆ TextureChildSlotName()

◆ UpdateDocumentTables()