Rhino C++ API
8.10
|
#include <RhRdkDocument.h>
Classes | |
class | CTypeBrowserParams |
Public Types | |
enum | : unsigned int { it_Normal = 0x0000, it_IncludeDefault = 0x0001, it_IncludeProxies = 0x0002, it_IncludeAutoDeleted = 0x0004, it_ForDisplay = 0x0008 } |
enum | { ccbu_hide_new_tab = 0x0001, ccbu_hide_existing_tab = 0x0002, ccbu_multiple_selection = 0x0004, ccbu_allow_none = 0x0008, ccbu_disable_import_button = 0x0010, ccbu_force32bit = 0xFFFFFFFF } |
enum | { ccc_AllowNone = 0x0001, ccc_AutoEdit = 0x0002, ccc_Preserve = 0x0004, ccc_AutoEditBM = 0x0008, ccc_NoGroupChange = 0x0010, ccc_HideNewTab = 0x0020, ccc_HideExistingTab = 0x0040, ccc_HarvestMask = 0xF000, ccc_HarvestUseOpt = 0x0000, ccc_HarvestAlways = 0x1000, ccc_HarvestNever = 0x2000, ccc_force32bit = 0xFFFFFFFF } |
enum | SctbResult : unsigned int { SctbResult::kNone, SctbResult::kNew, SctbResult::kCopy, SctbResult::kInstance } |
Static Public Member Functions | |
static const CRhRdkDocument & | Get (const CRhinoDoc &doc) |
static const CRhRdkDocument * | Get (const CRhRdkContentArray &aContent) |
static const CRhRdkDocument * | Get (const UUID &uuidRdkDoc) |
static bool | Match (const CRhRdkDocument *pRdkDoc, const CRhRdkDocument &other) |
static bool | Match (const CRhRdkDocument *pRdkDoc1, const CRhRdkDocument *pRdkDoc2) |
![]() | |
static void | CheckMemory (void) |
static void | PopulateDebuggingInfo (void) |
Protected Member Functions | |
CRhRdkDocument (bool) | |
CRhRdkDocument (unsigned int) | |
virtual | ~CRhRdkDocument () |
Friends | |
class | CRhRdkDocuments |
class | IRhRdkContents |
anonymous enum : unsigned int |
anonymous enum |
Bit-flags for CreateContentByUser() and ShowContentTypeBrowser() uFlags.
Enumerator | |
---|---|
ccbu_hide_new_tab | |
ccbu_hide_existing_tab | |
ccbu_multiple_selection | |
ccbu_allow_none | |
ccbu_disable_import_button | |
ccbu_force32bit |
anonymous enum |
Bit-flags for ChangeChildContent() uFlags.
|
strong |
Result of ShowContentTypeBrowser()
Enumerator | |
---|---|
kNone | |
kNew | |
kCopy | |
kInstance |
|
explicitprotected |
|
explicitprotected |
|
protectedvirtual |
|
virtual |
|
virtual |
Attach a content to the document by transferring ownership of it to the document.
c | is the content to attach. |
|
virtual |
Begins a change or batch of changes. This returns a non-const reference to this document which you should use to make your changes. Calls to this method are counted; you must call EndChange() once for every call to BeginChange(). Please do not use const_cast or any other means of circumventing this requirement.
cc | is the change context. |
|
virtual |
Change a content's child by allowing the user to choose the new content type from a content browser dialog. The child is created if it does not exist, otherwise the old child is deleted and replaced by the new child (unless ccc_Preserve is specified in which case the old child is optionally preserved as a child of the new child).
parent | is the content whose child is to be manipulated. |
wszChildSlotName | is the child-slot name of the child to be manipulated. |
allowedKinds | determines which content kinds are allowed to be chosen from the content browser dialog. |
ccc_Flags | is a set of flags for controlling the operation of the function (see ccc_ enum above). |
|
virtual |
Replace a content in the document. Deprecated in favor of ReplaceContent().
|
virtual |
Allows the user to choose a content by displaying the Content Instance Browser dialog. The dialog will have OK, Cancel and Help buttons, and optional New and Edit buttons.
uuidInstanceInOut | sets the initially selected content and receives the instance id of the chosen content. |
kinds | specifies the kind(s) of content that should be displayed in the browser. |
rdkcce_Flags | specifies flags controlling the browser. See enum in RhRdkDefinitions.h |
|
virtual |
kind | is the content kind for which to find the list. |
IRhRdkContents& CRhRdkDocument::Contents | ( | void | ) |
const IRhRdkContents& CRhRdkDocument::Contents | ( | void | ) | const |
|
virtual |
Creates a new content of the specified type and attaches it to the document.
uuidNewType | is the type of the content to create. |
pParent | is the parent content. If not null, this must be an RDK-owned content that is attached to the document (either top-level or child). The new content then becomes its child. If null, the new content is added to the document's top-level content list instead. |
wszChildSlotName | is the unique child identifier to use for the new content when creating it as a child of pParent (i.e., when pParent is not null). |
uFlags | is for future use only. |
|
virtual |
Create one or more new content(s) chosen by the user and attach them to the document.
aContentOut | accepts the new content(s). If you want to modify the contents you will need to call BeginChange() to get a non-const reference. |
uuidDefaultType | is the default content type. |
uuidDefaultInstance | is the default selected content instance. |
allowedKinds | determines which content kinds are allowed to be chosen from the dialog. |
uFlags | is from the enum above with prefix ccbu_ |
RDK_DEPRECATED IRhRdkCurrentEnvironment& CRhRdkDocument::CurrentEnvironment | ( | void | ) |
const RDK_DEPRECATED IRhRdkCurrentEnvironment& CRhRdkDocument::CurrentEnvironment | ( | void | ) | const |
ON_wString CRhRdkDocument::DebugString | ( | int | uuid_len | ) | const |
RDK_DEPRECATED ON_wString CRhRdkDocument::DebugString | ( | void | ) | const |
|
virtual |
This method is implemented as
|
virtual |
Detach a content from the document by transferring ownership of it to the caller.
c | is the content to detach. If successful, ownership of the content will be transferred to the caller. |
RDK_DEPRECATED IRhRdkDithering& CRhRdkDocument::Dithering | ( | void | ) |
const RDK_DEPRECATED IRhRdkDithering& CRhRdkDocument::Dithering | ( | void | ) | const |
|
virtual |
|
virtual |
Ends a change or batch of changes. Calls to this method are counted; you must call EndChange() once for every call to BeginChange().
|
virtual |
|
virtual |
Find a content by its instance id. All document-registered contents (including children) will be checked.
bCheckGlobal | determines if global contents should also be checked. Global contents are non-document contents that happen to be on the stack or the heap. If this is true, global contents will be checked if the content was not found in the document. If false, the search is restricted to document contents only. |
uuidInstance | is the instance id of the content to find. |
|
virtual |
Searches for contents with a particular instance name.
kinds | specifies which top-level content kinds should be searched. |
wszName | is the name to search for. |
bCaseSensitive | specifies if the name check is case-sensitive or not. |
bRecurse | specifies if children of top-level contents should be searched. |
aContentOut | accepts all the contents that satisfy the search. If you want to modify these contents you will need to call BeginChange() to get a non-const reference. |
|
virtual |
Searches for a content with the same name and appearance as another content.
c | is the content to match against. |
|
static |
Get the RDK document which is associated with the given Rhino document.
doc | is the Rhino document. |
|
static |
Get the RDK document which is associated with an array of content.
aContent | is the array of content. |
|
static |
Get an RDK document by its unique identifier.
uuidRdkDoc | is the identifier of the RDK document. |
|
virtual |
|
virtual |
|
virtual |
This method is obsolete.
RDK_DEPRECATED IRhRdkGroundPlane& CRhRdkDocument::GroundPlane | ( | void | ) |
const RDK_DEPRECATED IRhRdkGroundPlane& CRhRdkDocument::GroundPlane | ( | void | ) | const |
|
virtual |
CImpl& CRhRdkDocument::Impl | ( | void | ) | const |
|
virtual |
|
virtual |
|
virtual |
A 'sandbox' document is a temporary document that is not associated with a Rhino document. Sandboxes are used to hold and manipulate temporary contents in, for example, the Modal Editor.
RDK_DEPRECATED IRhRdkLinearWorkflow& CRhRdkDocument::LinearWorkflow | ( | void | ) |
const RDK_DEPRECATED IRhRdkLinearWorkflow& CRhRdkDocument::LinearWorkflow | ( | void | ) | const |
bool CRhRdkDocument::Match | ( | const CRhRdkDocument & | other | ) | const |
Checks if this document is the same as another document (by id).
bool CRhRdkDocument::Match | ( | const CRhRdkDocument * | pOther | ) | const |
Checks if this document is the same as another document (by id).
|
static |
Checks if two document are the same (by id).
|
static |
Checks if two document are the same (by id).
|
virtual |
|
virtual |
Get a new content iterator. The caller shall delete the iterator after use.
kinds | specifies the content kinds to return. |
it_Flags | are flags that control the iterator. See above. |
RDK_DEPRECATED IRhRdkPostEffects& CRhRdkDocument::PostEffects | ( | void | ) |
const RDK_DEPRECATED IRhRdkPostEffects& CRhRdkDocument::PostEffects | ( | void | ) | const |
RDK_DEPRECATED UUID CRhRdkDocument::PostEffectSelection | ( | const wchar_t * | ) | const |
RDK_DEPRECATED IRhRdkRenderChannels& CRhRdkDocument::RenderChannels | ( | void | ) |
const RDK_DEPRECATED IRhRdkRenderChannels& CRhRdkDocument::RenderChannels | ( | void | ) | const |
bool CRhRdkDocument::ReplaceContent | ( | const CRhRdkContent & | oldContent, |
CRhRdkContent & | newContent, | ||
bool | bPreserve = true |
||
) |
Replace a content in the document.
oldContent | is the content to detach and delete. |
newContent | is the content to attach in place of oldContent. If successful, the old content will be deleted and ownership of the new content will be transferred to the document. |
bPreserve | determines whether or not the instance id and notes are preserved. If true, the instance id of the old content is preserved in the new content. This means that any objects or layers that were referencing the old content will reference the new content. The same applies to the ground plane. The content's notes are also preserved. TODO: The name preserving is currently being reconsidered. [ANDY] |
|
virtual |
|
virtual |
RDK_DEPRECATED IRhRdkSafeFrame& CRhRdkDocument::SafeFrame | ( | void | ) |
const RDK_DEPRECATED IRhRdkSafeFrame& CRhRdkDocument::SafeFrame | ( | void | ) | const |
|
virtual |
Set whether or not tone mapping is to be applied when rendering.
|
virtual |
|
virtual |
RDK_DEPRECATED void CRhRdkDocument::SetPostEffectSelection | ( | const wchar_t * | , |
const UUID & | |||
) |
|
virtual |
Set a document setting by its name.
|
virtual |
Get a document setting by its name.
|
virtual |
This method is obsolete.
|
virtual |
This method is obsolete.
|
virtual |
This method is deprecated in favor of CRhinoDoc::Properties().RenderSettings().PostEffects().
SctbResult CRhRdkDocument::ShowContentTypeBrowser | ( | const CTypeBrowserParams & | params, |
CRhRdkInstanceIdArray & | aInstanceOut | ||
) | const |
Shows the content type browser to allow the user to select one or more new or existing contents.
params | specifies various parameters that control the browser. |
aInstanceOut | accepts the UUID(s) of the chosen item(s). Depending on SctbResult, this can be type ids of content types or instance ids of existing contents. |
|
virtual |
This method is deprecated in favor of the one below.
RDK_DEPRECATED IRhRdkSkylight& CRhRdkDocument::Skylight | ( | void | ) |
const RDK_DEPRECATED IRhRdkSkylight& CRhRdkDocument::Skylight | ( | void | ) | const |
RDK_DEPRECATED IRhRdkSun& CRhRdkDocument::Sun | ( | void | ) |
const RDK_DEPRECATED IRhRdkSun& CRhRdkDocument::Sun | ( | void | ) | const |
|
virtual |
|
virtual |
|
virtual |
This method is deprecated in favor of CRhinoDoc::Properties().RenderSettings().PostEffects().
|
virtual |
Calls UpdateDocumentTables() on all the contents in the RDK document.
|
friend |
|
friend |