The IActiveShadeFragmentManager class is used to control the active shade fragment (in-viewport) active shade. More...

#include <IActiveShadeFragmentManager.h>

Inheritance diagram for IActiveShadeFragmentManager:

Public Member Functions
virtual bool	ToggleInActiveViewport ()=0
	Toggle the use of Active Shade Fragment in current viewport Sample code in MAXScript : . More...

virtual void	SetRenderRegionInActiveViewport (float left, float top, float right, float bottom)=0
	Sets the render region for the active shade fragment, coordinates are between 0.0 and 1.0 This region is per viewport and not global to all viewports. More...

virtual void	RemoveActiveShadeFragmentFromAllViewports (void)=0
	Remove all running Active Shade fragments from all viewports from all view panels. More...

virtual Tab< int >	GetRunningActiveShadeViewportsIndices (void) const =0
	Get the viewports in which the Active Shade Fragments are running. More...

virtual bool	IsRunningInActiveViewport (void) const =0
	Is Active Shade Fragment running in current viewport ? More...

virtual bool	IsRunningInViewport (int viewPanelIndex, int viewportIndex) const =0
	Is Active Shade Fragment running in this viewport ? More...

virtual bool	IsRunningInAtLeastOneViewport (void) const =0
	Is Active Shade Fragment running at least in one viewport ? More...

virtual bool	CurrentActiveShadeRendererSupportsConcurrentRendering (void) const =0
	Does current Active Shade renderer support concurrent rendering ? If so we can have multiple active shade sessions running at the same time (for potential future use) More...

virtual IRenderProgressCallback *	GetActiveShadeFragmentProgressCallback (MaxSDK::Graphics::ViewFragment *pActiveshadeFragment)=0
	Send to the manager the ActiveShadeFragment and get as a result a IRenderProgressCallback* that can be used to forward the messages from the active shade renderer to the manager through IInteractiveRender::SetProgressCallback so it can display the messages or do progress bars etc. More...

virtual bool	RemoveActiveShadeFragmentProgressCallback (MaxSDK::Graphics::ViewFragment *pActiveshadeFragment)=0
	Remove from the manager the IRenderProgressCallback* from this ActiveShadeFragment. More...

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

The IActiveShadeFragmentManager class is used to control the active shade fragment (in-viewport) active shade.

Member Function Documentation

◆ ToggleInActiveViewport()

virtual bool ToggleInActiveViewport ( )

pure virtual

Toggle the use of Active Shade Fragment in current viewport
Sample code in MAXScript :
.

ActiveShadeFragmentManager.ToggleInActiveViewport()

Sample code in C++ :

MaxSDK::IActiveShadeFragmentManager* pActiveShadeFragmentManager = static_cast<MaxSDK::IActiveShadeFragmentManager*>(GetCOREInterface(IACTIVE_SHADE_VIEWPORT_MANAGER_INTERFACE));
if (nullptr != pActiveShadeFragmentManager) {
pActiveShadeFragmentManager->ToggleInActiveViewport();
}

Returns: true if it went fine in toggling

◆ SetRenderRegionInActiveViewport()

virtual void SetRenderRegionInActiveViewport	(	float	left,
		float	top,
		float	right,
		float	bottom
	)

pure virtual

Sets the render region for the active shade fragment, coordinates are between 0.0 and 1.0
This region is per viewport and not global to all viewports.

(0.0, 0.0) for the left and top coordinates are the top left corner of the viewport
(1.0, 1.0) for the right and bottom coordinates are the bottom right corner of the viewport

Parameters

left	: the left coordinate of the rectangle for the render region, range is 0.0 is the left of the viewport, 1.0 is the right of the viewport
top	: the top coordinate of the rectangle for the render region, range is 0.0 is the top of the viewport, 1.0 is the bottom of the viewport
right	: the left coordinate of the rectangle for the render region, range is 0.0 is the left of the viewport, 1.0 is the right of the viewport
bottom	: the bottom coordinate of the rectangle for the render region, range is 0.0 is the top of the viewport, 1.0 is the bottom of the viewport

◆ RemoveActiveShadeFragmentFromAllViewports()

virtual void RemoveActiveShadeFragmentFromAllViewports ( void )

pure virtual

Remove all running Active Shade fragments from all viewports from all view panels.

◆ GetRunningActiveShadeViewportsIndices()

virtual Tab<int> GetRunningActiveShadeViewportsIndices ( void ) const

pure virtual

Get the viewports in which the Active Shade Fragments are running.

Returns: a Tab<int> which are pairs of integers, so the count of the array is a multiple of 2. The first integer of each pair is a 0-based index of a ViewPanel and the second integer is the 0-based index of the viewport from that viewpanel that has active shade fragment running

◆ IsRunningInActiveViewport()

virtual bool IsRunningInActiveViewport ( void ) const

pure virtual

Is Active Shade Fragment running in current viewport ?

Returns: true if it is running in current viewport

◆ IsRunningInViewport()

virtual bool IsRunningInViewport	(	int	viewPanelIndex,
		int	viewportIndex
	)		const

pure virtual

Is Active Shade Fragment running in this viewport ?

Parameters

viewPanelIndex	- is the 0-based index of the viewpanel to use
viewportIndex	- is the 0-based index of the viewport to check in the viewpanel

Returns: true if it is running in the given viewport

◆ IsRunningInAtLeastOneViewport()

virtual bool IsRunningInAtLeastOneViewport ( void ) const

pure virtual

Is Active Shade Fragment running at least in one viewport ?

Returns: true if it is running in one viewport at least

◆ CurrentActiveShadeRendererSupportsConcurrentRendering()

virtual bool CurrentActiveShadeRendererSupportsConcurrentRendering ( void ) const

pure virtual

Does current Active Shade renderer support concurrent rendering ? If so we can have multiple active shade sessions running at the same time (for potential future use)

Returns: true if it supports concurrent rendering

◆ GetActiveShadeFragmentProgressCallback()

virtual IRenderProgressCallback* GetActiveShadeFragmentProgressCallback ( MaxSDK::Graphics::ViewFragment * pActiveshadeFragment )

pure virtual

Send to the manager the ActiveShadeFragment and get as a result a IRenderProgressCallback* that can be used to forward the messages from the active shade renderer
to the manager through IInteractiveRender::SetProgressCallback so it can display the messages or do progress bars etc.

Is only available through C++ and not through Maxscript

Parameters

pActiveshadeFragment - is a MaxSDK::Graphics::ViewFragment* that is an active shade fragment

Returns: the IRenderProgressCallback* to use with IInteractiveRender::SetProgressCallback or nullptr if a problem occured

◆ RemoveActiveShadeFragmentProgressCallback()

virtual bool RemoveActiveShadeFragmentProgressCallback ( MaxSDK::Graphics::ViewFragment * pActiveshadeFragment )

pure virtual

Remove from the manager the IRenderProgressCallback* from this ActiveShadeFragment.

Parameters

pActiveshadeFragment - is a MaxSDK::Graphics::ViewFragment* that is an active shade fragment

Returns: true if the manager successfully removed the callback

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ToggleInActiveViewport()

◆ SetRenderRegionInActiveViewport()

◆ RemoveActiveShadeFragmentFromAllViewports()

◆ GetRunningActiveShadeViewportsIndices()

◆ IsRunningInActiveViewport()

◆ IsRunningInViewport()

◆ IsRunningInAtLeastOneViewport()

◆ CurrentActiveShadeRendererSupportsConcurrentRendering()

◆ GetActiveShadeFragmentProgressCallback()

◆ RemoveActiveShadeFragmentProgressCallback()