IRenderRegionManager Class Reference

Represents access to render region editing for the viewport and VFB. More...

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/Rendering/IRenderRegionManager.h>

Inheritance diagram for IRenderRegionManager:

Public Member Functions
virtual bool	IsEditing ()=0
	Query whether the system is currently editing a region.
virtual bool	IsRegionEditable ()=0
	Query whether the current render mode supports region render editing.
virtual void	BeginRegionEdit ()=0
	Pushes the region command mode on to the command stack to start region editing.
virtual void	EndRegionEdit ()=0
	Pops the command mode off of the command stack to leave region editing.
virtual void	ToggleRegionEdit ()=0
	Helper that calls Begin/EndRegion to toggle between enabled and disabled.
virtual void	OnBeginRegionEdit ()=0
	Handler called when region editing has started.
virtual void	OnEndRegionEdit ()=0
	Handler called when region editing has ended.
virtual void	OnRegionSynchronize ()=0
	Handler called when the region or related conditions have changed.
virtual FBox2	GetRegionRectangle ()=0
	Get the render region (crop or blowup, depending on the current mode) in 0-1.0 space.
virtual FBox2	GetRegionRectangle (int viewID, RenderUIType renderType)=0
	Get the render region for a specific mode (crop or blowup) for a specific viewport.
virtual void	SetRegionRectangle (FBox2 region)=0
	Set the render region (crop or blowup, depending on the current mode) in 0-1.0 space.
virtual void	SetRegionRectangle (int viewID, RenderUIType renderType, FBox2 region)=0
	Set the render region for a specific mode (crop or blowup) for a specific viewport.
virtual void	PutRenderRegionUndo ()=0
	Mark the current region values for undo if the Hold is holding.
virtual bool	IsVFBCropCallback ()=0
	Whether the region manager is the current VFB crop handler.
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.
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.
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.
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
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)
void	InitProtected ()
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

Represents access to render region editing for the viewport and VFB.

Member Function Documentation

IsEditing()

virtual bool IsEditing ( )

pure virtual

Query whether the system is currently editing a region.

IsRegionEditable()

virtual bool IsRegionEditable ( )

pure virtual

Query whether the current render mode supports region render editing.

BeginRegionEdit()

virtual void BeginRegionEdit ( )

pure virtual

Pushes the region command mode on to the command stack to start region editing.

This action will switch to a region editable mode if the current render mode does not support regions.

EndRegionEdit()

virtual void EndRegionEdit ( )

pure virtual

Pops the command mode off of the command stack to leave region editing.

ToggleRegionEdit()

virtual void ToggleRegionEdit ( )

pure virtual

Helper that calls Begin/EndRegion to toggle between enabled and disabled.

OnBeginRegionEdit()

virtual void OnBeginRegionEdit ( )

pure virtual

Handler called when region editing has started.

OnEndRegionEdit()

virtual void OnEndRegionEdit ( )

pure virtual

Handler called when region editing has ended.

OnRegionSynchronize()

virtual void OnRegionSynchronize ( )

pure virtual

Handler called when the region or related conditions have changed.

This will notify region clients to update their display. This may also end editing if it is no longer valid (e.g. region render mode is no longer selected).

GetRegionRectangle() [1/2]

virtual FBox2 GetRegionRectangle ( )

pure virtual

Get the render region (crop or blowup, depending on the current mode) in 0-1.0 space.

GetRegionRectangle() [2/2]

virtual FBox2 GetRegionRectangle ( int viewID, RenderUIType renderType )

pure virtual

Get the render region for a specific mode (crop or blowup) for a specific viewport.

Parameters

viewID	The viewport id.
renderType	RENDER_CROP or RENDER_BLOWUP.

SetRegionRectangle() [1/2]

virtual void SetRegionRectangle ( FBox2 region )

pure virtual

Set the render region (crop or blowup, depending on the current mode) in 0-1.0 space.

This method creates a restore object if the Hold is holding.

Parameters

region

The render region.

SetRegionRectangle() [2/2]

virtual void SetRegionRectangle ( int viewID, RenderUIType renderType, FBox2 region )

pure virtual

Set the render region for a specific mode (crop or blowup) for a specific viewport.

Parameters

viewID	The viewport id.
renderType	RENDER_CROP or RENDER_BLOWUP.
region	The render region.

PutRenderRegionUndo()

virtual void PutRenderRegionUndo ( )

pure virtual

Mark the current region values for undo if the Hold is holding.

IsVFBCropCallback()

virtual bool IsVFBCropCallback ( )

pure virtual

Whether the region manager is the current VFB crop handler.