Rhino C++ API
8.10
|
#include <IRhRdkCurrentEnvironment.h>
Public Types | |
enum | Purpose : unsigned int { Purpose::Render = 0, Purpose::Simple = 1 } |
enum | Usage : unsigned int { Usage::Background = 0x01, Usage::Reflection = 0x02, Usage::Skylighting = 0x04, Usage::Any = Background | Reflection | Skylighting } |
Public Member Functions | |
virtual IRhRdkCurrentEnvironment & | BeginChange (RhRdkChangeContext cc) const =0 |
virtual void | CopyFrom (const IRhRdkCurrentEnvironment &ce)=0 |
virtual bool | EndChange (void)=0 |
virtual void * | EVF (const wchar_t *, void *)=0 |
virtual UUID | Get (Usage usage, Purpose p) const =0 |
virtual const class CRhRdkEnvironment * | GetEnv (Usage usage, Purpose p) const =0 |
virtual bool | On (Usage usage) const =0 |
virtual bool | Set (Usage usage, const UUID &uuidInstance)=0 |
virtual void | SetOn (Usage usage, bool bOn)=0 |
Protected Member Functions | |
virtual | ~IRhRdkCurrentEnvironment () |
This is the interface to the current environments for background, skylighting and reflection / refraction.
Ideally this interface would be deprecated and replaced by ON_3dmRenderSettings but we can't do that as the latter has no current environment interface.
The Usage and Purpose enums have the same meaning as those in ON_3dmRenderSettings::EnvironmentUsage but the values are different so be careful about the possible need to convert between them.
|
strong |
|
strong |
|
inlineprotectedvirtual |
|
pure virtual |
Call this method to get a non-const object upon which you can call non-const methods. 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.
|
pure virtual |
Copy this current environment from another one.
|
pure virtual |
|
pure virtual |
Emergency virtual function for future expansion.
Get the current environment instance id. If there is no current environment, the function returns the default environment's instance id.
|
pure virtual |
Get the current environment. If there is no current environment, the function returns the default environment.
|
pure virtual |
Get if the current environment is 'on' for a particular usage.
|
pure virtual |
Set the current environment instance id for a specific usage. Note that passing ON_nil_uuid for a usage will remove that specialization. If a usage is ON_nil_uuid, that usage will revert to the same as the background usage.
|
pure virtual |
Set if the current environment is 'on' for a particular usage.