Rhino C++ API  8.25
Static Public Attributes | List of all members
RhRdk::CustomRenderMeshes::IManager::Flags Struct Reference

Flags to be passed into and returned from RenderMeshes and HasCustomRenderMeshes.
More...

#include <IRhRdkCustomRenderMeshes.h>

Static Public Attributes

static const ON__UINT32 AlwaysCopyDocumentContent = 16
 Pass in this flag to ensure that materials, environments and textures that refer to document objects are always copied. This makes the RenderMeshes object safe to be stored outside of the lifetime of those objects - in caches, or for use in threaded situtations. More...
 
static const ON__UINT32 Canceled = 1
 If this flag is set when returned, then CustomMeshes was canceled. More...
 
static const ON__UINT32 DisableCaching = 2
 Pass in this flag to bypass any primitive caching that the MeshProviders might do. More...
 
static const ON__UINT32 Incomplete = 64
 This flag is returned when an asynchronous operation (like Displacement) has not yet completed. More...
 
static const ON__UINT32 IsDocumentObject = 8
 Pass in this flag to indicate that the object id is a document resident object. If the flag is not set and IsNonDocumentObject is not set, we will use an expensive method to discover. In other words, one of these flags should be set for optimum speed. More...
 
static const ON__UINT32 IsNonDocumentObject = 128
 Pass in this flag to indicate that the object id is NOT a document resident object.. If the flag is not set and IsDocumentObject is not set, we will use an expensive method to discover. In other words, one of these flags should be set for optimum speed. More...
 
static const ON__UINT32 None = 0
 No flags More...
 
static const ON__UINT32 Recursive = 4
 Pass in this flag to get the render meshes for entire blocks. Only has an effect if the ObjectId is a block reference, and if it will not produce CRMs of its own. More...
 
static const ON__UINT32 ReturnNullForStandardMaterial = 32
 Pass in this flag to request that nullptr is returned when the material on a mesh should be the standard material used - in otherwords, not customized by this RenderMeshes object. Note that this will require document access to resolve - do not use in threaded situations. More...
 

Detailed Description

Flags to be passed into and returned from RenderMeshes and HasCustomRenderMeshes.

Member Data Documentation

◆ AlwaysCopyDocumentContent

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::AlwaysCopyDocumentContent = 16
static

Pass in this flag to ensure that materials, environments and textures that refer to document objects are always copied. This makes the RenderMeshes object safe to be stored outside of the lifetime of those objects - in caches, or for use in threaded situtations.

◆ Canceled

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::Canceled = 1
static

If this flag is set when returned, then CustomMeshes was canceled.

◆ DisableCaching

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::DisableCaching = 2
static

Pass in this flag to bypass any primitive caching that the MeshProviders might do.

◆ Incomplete

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::Incomplete = 64
static

This flag is returned when an asynchronous operation (like Displacement) has not yet completed.

◆ IsDocumentObject

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::IsDocumentObject = 8
static

Pass in this flag to indicate that the object id is a document resident object. If the flag is not set and IsNonDocumentObject is not set, we will use an expensive method to discover. In other words, one of these flags should be set for optimum speed.

◆ IsNonDocumentObject

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::IsNonDocumentObject = 128
static

Pass in this flag to indicate that the object id is NOT a document resident object.. If the flag is not set and IsDocumentObject is not set, we will use an expensive method to discover. In other words, one of these flags should be set for optimum speed.

◆ None

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::None = 0
static

No flags

◆ Recursive

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::Recursive = 4
static

Pass in this flag to get the render meshes for entire blocks. Only has an effect if the ObjectId is a block reference, and if it will not produce CRMs of its own.

◆ ReturnNullForStandardMaterial

const ON__UINT32 RhRdk::CustomRenderMeshes::IManager::Flags::ReturnNullForStandardMaterial = 32
static

Pass in this flag to request that nullptr is returned when the material on a mesh should be the standard material used - in otherwords, not customized by this RenderMeshes object. Note that this will require document access to resolve - do not use in threaded situations.