PluginPackageInfo Class Reference

A plugin package may contain various pieces of information including name, package description, company email, and so on. More...

#include <PluginPackageInfo.h>

Inheritance diagram for PluginPackageInfo:

Public Member Functions
const MCHAR *	GetPackageName () const
	Get the plugin package name. More...
const MCHAR *	GetPackageVersionString () const
	Get version information for this plugin package, in the form of "MMM.mmm.bbb" (major.minor.build) The version information is used by 3ds Max to determine which plugin package to load if multiple plugin packages with the same UpgradeCode are found. More...
const MCHAR *	GetPackageDescription () const
	Get the human readable description of the plugin package. More...
const MCHAR *	GetUpgradeCode () const
	Get the UpgradeCode for this plugin package. More...
const MCHAR *	GetPackageDirectory () const
	Get the directory where this plugin package is installed. More...
const MCHAR *	GetCompanyName () const
	Get name of the company that created this plugin package. More...
const MCHAR *	GetCompanyUrl () const
	Get url to reference back to the company that created this plugin package (as a string, no format required in the package format) More...
const MCHAR *	GetCompanyEmail () const
	Get email of the company that created this plugin package (as a string, no format required in the plugin package format) More...
const MCHAR *	GetCompanyPhone () const
	Get phone of the company that created this plugin package. More...
virtual	~PluginPackageInfo ()
	PluginPackageInfo (const PluginPackageInfo &)=delete
PluginPackageInfo &	operator= (const PluginPackageInfo &)=delete
	PluginPackageInfo (Impl *in_pImpl)

Additional Inherited Members
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...

Detailed Description

A plugin package may contain various pieces of information including name, package description, company email, and so on.

PluginPackageInfo regroups all this information. The details of the packaging format can be found in the "Packaging Plug-ins" topic in the 3ds Max Developer's Guide. Please consult the documentation of PluginPackageManager for more details.

Constructor & Destructor Documentation

~PluginPackageInfo()

virtual ~PluginPackageInfo ( )

virtual

PluginPackageInfo() [1/2]

PluginPackageInfo ( const PluginPackageInfo &  )

delete

PluginPackageInfo() [2/2]

PluginPackageInfo ( Impl *  in_pImpl )

explicit

Member Function Documentation

GetPackageName()

const MCHAR* GetPackageName

(

)

const

Get the plugin package name.

GetPackageVersionString()

const MCHAR* GetPackageVersionString

(

)

const

Get version information for this plugin package, in the form of "MMM.mmm.bbb" (major.minor.build) The version information is used by 3ds Max to determine which plugin package to load if multiple plugin packages with the same UpgradeCode are found.

GetPackageDescription()

const MCHAR* GetPackageDescription

(

)

const

Get the human readable description of the plugin package.

GetUpgradeCode()

const MCHAR* GetUpgradeCode

(

)

const

Get the UpgradeCode for this plugin package.

This will be a GUID string. The UpgradeCode is a unique GUID for the plugin package that must never be changed across all versions of the plugin package. The UpgradeCode is used by the Autodesk App Store website to allow for upgrading from an old version to a newer version of a plugin package without the need to uninstall the plugin package first. The UpgradeCode is used by 3ds Max to uniquely identify plugin packages.

GetPackageDirectory()

const MCHAR* GetPackageDirectory

(

)

const

Get the directory where this plugin package is installed.

GetCompanyName()

const MCHAR* GetCompanyName

(

)

const

Get name of the company that created this plugin package.

GetCompanyUrl()

const MCHAR* GetCompanyUrl

(

)

const

Get url to reference back to the company that created this plugin package (as a string, no format required in the package format)

GetCompanyEmail()

const MCHAR* GetCompanyEmail

(

)

const

Get email of the company that created this plugin package (as a string, no format required in the plugin package format)

GetCompanyPhone()

const MCHAR* GetCompanyPhone

(

)

const

Get phone of the company that created this plugin package.

operator=()

PluginPackageInfo& operator= ( const PluginPackageInfo &  )

delete