IBitmapIO_RLA Class Reference

The IBitmapIO_RLA class expands upon the previous IBitmapIO classes. More...

#include <istdplug.h>

Inheritance diagram for IBitmapIO_RLA:

Public Member Functions
virtual int	GetColorDepth ()=0
virtual void	SetColorDepth (int bpp)=0
virtual BOOL	GetStoreAlpha ()=0
virtual void	SetStoreAlpha (BOOL storeAlpha)=0
virtual BOOL	GetPremultAlpha ()=0
virtual void	SetPremultAlpha (BOOL preMult)=0
virtual MSTR	GetDescription ()=0
virtual void	SetDescription (const MSTR &desc)=0
virtual MSTR	GetAuthor ()=0
virtual void	SetAuthor (const MSTR &author)=0
virtual BOOL	GetZChannel ()=0
virtual void	SetZChannel (BOOL b)=0
virtual BOOL	GetMtlIDChannel ()=0
virtual void	SetMtlIDChannel (BOOL b)=0
virtual BOOL	GetNodeIDChannel ()=0
virtual void	SetNodeIDChannel (BOOL b)=0
virtual BOOL	GetUVChannel ()=0
virtual void	SetUVChannel (BOOL b)=0
virtual BOOL	GetNormalChannel ()=0
virtual void	SetNormalChannel (BOOL b)=0
virtual BOOL	GetRealpixChannel ()=0
virtual void	SetRealpixChannel (BOOL b)=0
virtual BOOL	GetCoverageChannel ()=0
virtual void	SetCoverageChannel (BOOL b)=0
virtual BOOL	GetNodeRenderIDChannel ()=0
virtual void	SetNodeRenderIDChannel (BOOL b)=0
virtual BOOL	GetColorChannel ()=0
virtual void	SetColorChannel (BOOL b)=0
virtual BOOL	GetTranspChannel ()=0
virtual void	SetTranspChannel (BOOL b)=0
virtual BOOL	GetVelocChannel ()=0
virtual void	SetVelocChannel (BOOL b)=0
virtual BOOL	GetWeightChannel ()=0
virtual void	SetWeightChannel (BOOL b)=0
virtual BOOL	GetMaskChannel ()=0
virtual void	SetMaskChannel (BOOL b)=0
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 BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
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)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
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.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
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)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

The IBitmapIO_RLA class expands upon the previous IBitmapIO classes.

See also

Class IBitmapIO

Description:

The IBitmapIO_RLA class expands upon the previous IBitmapIO classes for .bmp, .jpeg, .png and .tga. Like these others, it is a static interface; the code to fetch the interface is given below. The interface does not directly change the configuration of an existing BitmapIO. Instead, these methods set the default values, which will be used the next time an RLA or RPF file is saved. The defaults will also appear in the bitmap configuration dialog if the user saves an RLA or RPF file.

Usage:

Both RLA and RPF have the same interface class, IBitmapIO_RLA, but some of the methods of this class are RPF-specific, giving undefined behavior if used on an RLA instance of the class.

DllDir* dllDir = GetCOREInterface()->GetDllDirectory();
ClassDirectory& classDir = dllDir->ClassDir();
ClassEntry* classEntry = classDir.FindClassEntry( BMM_IO_CLASS_ID, Class_ID(RPFCLASSID,0));
ClassDesc* classDesc = classEntry->FullCD();
return classDesc->GetInterface( RPFIO_INTERFACE ); 
// You can substitute RLACLASSID and RLAIO_INTERFACE if you want the RLA interface.

Member Function Documentation

GetColorDepth()

virtual int GetColorDepth ( )

pure virtual

SetColorDepth()

virtual void SetColorDepth ( int  bpp )

pure virtual

GetStoreAlpha()

virtual BOOL GetStoreAlpha ( )

pure virtual

SetStoreAlpha()

virtual void SetStoreAlpha ( BOOL  storeAlpha )

pure virtual

GetPremultAlpha()

virtual BOOL GetPremultAlpha ( )

pure virtual

SetPremultAlpha()

virtual void SetPremultAlpha ( BOOL  preMult )

pure virtual

GetDescription()

virtual MSTR GetDescription ( )

pure virtual

SetDescription()

virtual void SetDescription ( const MSTR &  desc )

pure virtual

GetAuthor()

virtual MSTR GetAuthor ( )

pure virtual

SetAuthor()

virtual void SetAuthor ( const MSTR &  author )

pure virtual

GetZChannel()

virtual BOOL GetZChannel ( )

pure virtual

SetZChannel()

virtual void SetZChannel ( BOOL  b )

pure virtual

GetMtlIDChannel()

virtual BOOL GetMtlIDChannel ( )

pure virtual

SetMtlIDChannel()

virtual void SetMtlIDChannel ( BOOL  b )

pure virtual

GetNodeIDChannel()

virtual BOOL GetNodeIDChannel ( )

pure virtual

SetNodeIDChannel()

virtual void SetNodeIDChannel ( BOOL  b )

pure virtual

GetUVChannel()

virtual BOOL GetUVChannel ( )

pure virtual

SetUVChannel()

virtual void SetUVChannel ( BOOL  b )

pure virtual

GetNormalChannel()

virtual BOOL GetNormalChannel ( )

pure virtual

SetNormalChannel()

virtual void SetNormalChannel ( BOOL  b )

pure virtual

GetRealpixChannel()

virtual BOOL GetRealpixChannel ( )

pure virtual

SetRealpixChannel()

virtual void SetRealpixChannel ( BOOL  b )

pure virtual

GetCoverageChannel()

virtual BOOL GetCoverageChannel ( )

pure virtual

SetCoverageChannel()

virtual void SetCoverageChannel ( BOOL  b )

pure virtual

GetNodeRenderIDChannel()

virtual BOOL GetNodeRenderIDChannel ( )

pure virtual

SetNodeRenderIDChannel()

virtual void SetNodeRenderIDChannel ( BOOL  b )

pure virtual

GetColorChannel()

virtual BOOL GetColorChannel ( )

pure virtual

SetColorChannel()

virtual void SetColorChannel ( BOOL  b )

pure virtual

GetTranspChannel()

virtual BOOL GetTranspChannel ( )

pure virtual

SetTranspChannel()

virtual void SetTranspChannel ( BOOL  b )

pure virtual

GetVelocChannel()

virtual BOOL GetVelocChannel ( )

pure virtual

SetVelocChannel()

virtual void SetVelocChannel ( BOOL  b )

pure virtual

GetWeightChannel()

virtual BOOL GetWeightChannel ( )

pure virtual

SetWeightChannel()

virtual void SetWeightChannel ( BOOL  b )

pure virtual

GetMaskChannel()

virtual BOOL GetMaskChannel ( )

pure virtual

SetMaskChannel()

virtual void SetMaskChannel ( BOOL  b )

pure virtual