#include <IRhRdkCurrentEnvironment.h>
This interface can be used to access the current environments.
- See also
- CRhRdkDocument::CurrentEnvironment()
◆ Purpose
◆ Usage
Enumerator |
---|
Background | |
Reflection | |
Skylighting | |
Any | |
◆ ~IRhRdkCurrentEnvironment()
virtual IRhRdkCurrentEnvironment::~IRhRdkCurrentEnvironment |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ BeginChange()
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.
◆ CopyFrom()
Copy this current environment from another one.
◆ EndChange()
virtual bool IRhRdkCurrentEnvironment::EndChange |
( |
void |
| ) |
|
|
pure virtual |
◆ EVF()
virtual void* IRhRdkCurrentEnvironment::EVF |
( |
const wchar_t * |
, |
|
|
void * |
|
|
) |
| |
|
pure virtual |
Emergency virtual function for future expansion.
◆ Get()
virtual UUID IRhRdkCurrentEnvironment::Get |
( |
Usage |
usage, |
|
|
Purpose |
p |
|
) |
| const |
|
pure virtual |
Get the current environment instance id. If there is no current environment, the function returns the default environment's instance id.
◆ GetEnv()
Get the current environment. If there is no current environment, the function returns the default environment.
◆ On()
virtual bool IRhRdkCurrentEnvironment::On |
( |
Usage |
usage | ) |
const |
|
pure virtual |
Get if the current environment is 'on' for a particular usage.
◆ Set()
virtual bool IRhRdkCurrentEnvironment::Set |
( |
Usage |
usage, |
|
|
const UUID & |
uuidInstance |
|
) |
| |
|
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.
◆ SetOn()
virtual void IRhRdkCurrentEnvironment::SetOn |
( |
Usage |
usage, |
|
|
bool |
bOn |
|
) |
| |
|
pure virtual |
Set if the current environment is 'on' for a particular usage.