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

#include <IRhRdkSectionHolder.h>

Public Member Functions

virtual void * EVF (const wchar_t *wszFunc, void *pvData)=0
 
virtual CRhRdkVariant GetParameter (const wchar_t *wszName, const CRhRdkVariant &vDefault) const =0
 
virtual void GetPostEffects (IRhRdkPostEffect::Types type, ON_SimpleArray< const IRhRdkPostEffect * > &aPostEffects) const =0
 
virtual UUID PostEffectId (void) const =0
 
virtual bool SetParameter (const wchar_t *wszName, const CRhRdkVariant &vValue)=0
 

Static Public Member Functions

static CRhRdkVariant GetParameter (const IRhinoUiWithController &ui, const UUID &uuidPostEffect, const wchar_t *wszName, const CRhRdkVariant &vDefault)
 
static void GetPostEffects (const IRhinoUiWithController &ui, const UUID &uuidPostEffect, ON_SimpleArray< const IRhRdkPostEffect * > &aPostEffects)
 
static void GetPostEffects (const IRhinoUiWithController &ui, IRhRdkPostEffect::Types type, ON_SimpleArray< const IRhRdkPostEffect * > &aPostEffects)
 
static bool SetParameter (const IRhinoUiWithController &ui, const UUID &uuidPostEffect, const wchar_t *wszName, const CRhRdkVariant &vValue)
 

Protected Member Functions

virtual ~IRhRdkPostEffectSection ()
 

Constructor & Destructor Documentation

◆ ~IRhRdkPostEffectSection()

virtual IRhRdkPostEffectSection::~IRhRdkPostEffectSection ( )
inlineprotectedvirtual

Member Function Documentation

◆ EVF()

virtual void* IRhRdkPostEffectSection::EVF ( const wchar_t *  wszFunc,
void *  pvData 
)
pure virtual

Emergency virtual function for future expansion.

◆ GetParameter() [1/2]

static CRhRdkVariant IRhRdkPostEffectSection::GetParameter ( const IRhinoUiWithController ui,
const UUID &  uuidPostEffect,
const wchar_t *  wszName,
const CRhRdkVariant vDefault 
)
static

◆ GetParameter() [2/2]

virtual CRhRdkVariant IRhRdkPostEffectSection::GetParameter ( const wchar_t *  wszName,
const CRhRdkVariant vDefault 
) const
pure virtual

Implement this method to return a named post effect parameter.

◆ GetPostEffects() [1/3]

static void IRhRdkPostEffectSection::GetPostEffects ( const IRhinoUiWithController ui,
const UUID &  uuidPostEffect,
ON_SimpleArray< const IRhRdkPostEffect * > &  aPostEffects 
)
static

◆ GetPostEffects() [2/3]

static void IRhRdkPostEffectSection::GetPostEffects ( const IRhinoUiWithController ui,
IRhRdkPostEffect::Types  type,
ON_SimpleArray< const IRhRdkPostEffect * > &  aPostEffects 
)
static

◆ GetPostEffects() [3/3]

virtual void IRhRdkPostEffectSection::GetPostEffects ( IRhRdkPostEffect::Types  type,
ON_SimpleArray< const IRhRdkPostEffect * > &  aPostEffects 
) const
pure virtual

Get the post effects using this section. Currently, this returns only one item.

◆ PostEffectId()

virtual UUID IRhRdkPostEffectSection::PostEffectId ( void  ) const
pure virtual

Implement this method to return the id of your post effect.

◆ SetParameter() [1/2]

static bool IRhRdkPostEffectSection::SetParameter ( const IRhinoUiWithController ui,
const UUID &  uuidPostEffect,
const wchar_t *  wszName,
const CRhRdkVariant vValue 
)
static

◆ SetParameter() [2/2]

virtual bool IRhRdkPostEffectSection::SetParameter ( const wchar_t *  wszName,
const CRhRdkVariant vValue 
)
pure virtual

Implement this method to set a named post effect parameter.