Rhino C++ API  8.7
Public Types | Public Member Functions | Static Public Member Functions | List of all members
IRhRdkRenderChannels Class Referenceabstract

#include <IRhRdkRenderChannels.h>

Public Types

enum  Modes : unsigned int { Modes::Automatic, Modes::Custom }
 Mode. More...
 

Public Member Functions

virtual ~IRhRdkRenderChannels ()
 
virtual IRhRdkRenderChannelsBeginChange (RhRdkChangeContext cc) const =0
 
virtual void BeginNotifyBracket (void)=0
 
virtual void CopyFrom (const IRhRdkRenderChannels &rch)=0
 
virtual bool EndChange (void)=0
 
virtual void EndNotifyBracket (void)=0
 
virtual void * EVF (const wchar_t *, void *)=0
 
virtual void GetCustomList (OUT ON_SimpleArray< UUID > &aChan) const =0
 
virtual Modes Mode (void) const =0
 
virtual void SetCustomList (const ON_SimpleArray< UUID > &aChan)=0
 
virtual void SetMode (Modes m)=0
 

Static Public Member Functions

static IRhRdkRenderChannelsNew (void)
 

Detailed Description

This interface is deprecated and only kept for backward compatibility.

Member Enumeration Documentation

◆ Modes

enum IRhRdkRenderChannels::Modes : unsigned int
strong

Mode.

Enumerator
Automatic 

Render-channels are managed automatically

Custom 

Render-channels are specified by the user

Constructor & Destructor Documentation

◆ ~IRhRdkRenderChannels()

virtual IRhRdkRenderChannels::~IRhRdkRenderChannels ( )
inlinevirtual

Member Function Documentation

◆ BeginChange()

virtual IRhRdkRenderChannels& IRhRdkRenderChannels::BeginChange ( RhRdkChangeContext  cc) const
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.

◆ BeginNotifyBracket()

virtual void IRhRdkRenderChannels::BeginNotifyBracket ( void  )
pure virtual

Call this before calling multiple 'Set' methods.

◆ CopyFrom()

virtual void IRhRdkRenderChannels::CopyFrom ( const IRhRdkRenderChannels rch)
pure virtual

Copy this object from another one.

◆ EndChange()

virtual bool IRhRdkRenderChannels::EndChange ( void  )
pure virtual

◆ EndNotifyBracket()

virtual void IRhRdkRenderChannels::EndNotifyBracket ( void  )
pure virtual

Call this after calling multiple 'Set' methods.

◆ EVF()

virtual void* IRhRdkRenderChannels::EVF ( const wchar_t *  ,
void *   
)
pure virtual

Emergency virtual function for future expansion.

◆ GetCustomList()

virtual void IRhRdkRenderChannels::GetCustomList ( OUT ON_SimpleArray< UUID > &  aChan) const
pure virtual

Get the list of channels to render when in 'custom' mode.

Parameters
aChanaccepts the channel ids.

◆ Mode()

virtual Modes IRhRdkRenderChannels::Mode ( void  ) const
pure virtual

Get the mode.

◆ New()

static IRhRdkRenderChannels* IRhRdkRenderChannels::New ( void  )
static

◆ SetCustomList()

virtual void IRhRdkRenderChannels::SetCustomList ( const ON_SimpleArray< UUID > &  aChan)
pure virtual

Set the list of channels to render when in 'custom' mode.

Parameters
aChancontains the channel ids.

◆ SetMode()

virtual void IRhRdkRenderChannels::SetMode ( Modes  m)
pure virtual

Set the mode.