3ds Max C++ API Reference
Loading...
Searching...
No Matches
ArnoldMaxVolumeInterfaceObject Class Referenceabstract

Generic interface class used to access Max volumes for rendering, etc. More...

#include <ArnoldMaxVolumeInterface.h>

+ Inheritance diagram for ArnoldMaxVolumeInterfaceObject:

Public Member Functions

 ArnoldMaxVolumeInterfaceObject ()=default
 
virtual ~ArnoldMaxVolumeInterfaceObject ()=default
 
virtual float GetStepSize (TimeValue t)=0
 Query for volume step size at the given time.
 
virtual float GetStepScale (TimeValue t)=0
 Query for volume step scale at the given time.
 
virtual float GetPadding (TimeValue t)=0
 Query for volume bounds padding amount at the given time.
 
virtual float GetVelOut (TimeValue t)=0
 Query for velocity value at the given time.
 
virtual float GetVelScale (TimeValue t)=0
 Query for velocity scale at the given time.
 
- Public Member Functions inherited from MaxVolumeInterfaceObject
 MaxVolumeInterfaceObject ()=default
 
virtual ~MaxVolumeInterfaceObject ()=default
 
virtual bool IsPrimaryGridFogVolume ()=0
 Query for primary volume type.
 
virtual void GetFogVolumeGridNames (MaxSDK::Array< MSTR > &fogVolumeGridNames)=0
 Fills in the array with the names of the fog volume grids (if any).
 
virtual void GetLevelSetGridNames (MaxSDK::Array< MSTR > &levelSetGridNames)=0
 Fills in the array with the names of the level set grids (if any).
 
virtual void GetVelocityGridNames (MaxSDK::Array< MSTR > &velocityGridNames)=0
 Fills in the array with the names of the velocity grids (if any).
 
virtual bool CanStreamCache () const
 Query the object to see if it has an in-memory OpenVDB grid cache that is capable of streaming.
 
virtual bool StreamGrids (std::ostringstream &streamOut, TimeValue t, Interval &valid)
 Ask the volume object to stream all of its grids to a cache.
 
virtual bool StreamGrids (const MaxSDK::Array< MSTR > &channelNames, std::ostringstream &streamOut, TimeValue t, Interval &valid)
 Ask the volume object to stream a specific set of its grids to a cache.
 
virtual bool HasDiskCache () const
 Query the object to see if it has its own cache file.
 
virtual MSTR GetDiskCache (TimeValue t, Interval &valid)
 If the object has its own cache file, this retrieves its name for a given time along with validity.
 
virtual bool BuildDiskCache (const MSTR &filename, TimeValue t, Interval &valid)
 If the object doesn't have its own cache file, this will build one with all grids for us, placing it in the specified filename.
 
virtual bool BuildDiskCache (const MaxSDK::Array< MSTR > &channelNames, const MSTR &filename, TimeValue t, Interval &valid)
 If the object doesn't have its own cache file, this will build one with all specified grids for us, placing it in the specified filename.
 
virtual MtlGetVolumeShader (TimeValue t)
 Get the shader assigned to this volume (if any).
 
virtual Box3 GetVolumeBBox (TimeValue t)=0
 Get the bounding box for the volume at the specified time.
 
virtual Interval VolumeObjectValidity (TimeValue t)
 Get the validity interval for the volume at the specified time.
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
 
UtilExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (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 voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_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.
 

Detailed Description

Generic interface class used to access Max volumes for rendering, etc.

Constructor & Destructor Documentation

◆ ArnoldMaxVolumeInterfaceObject()

◆ ~ArnoldMaxVolumeInterfaceObject()

virtual ~ArnoldMaxVolumeInterfaceObject ( )
virtualdefault

Member Function Documentation

◆ GetStepSize()

virtual float GetStepSize ( TimeValue  t)
pure virtual

Query for volume step size at the given time.

Parameters:
TimeValue t - The time to use for the data
Returns
the step size for the volume.

◆ GetStepScale()

virtual float GetStepScale ( TimeValue  t)
pure virtual

Query for volume step scale at the given time.

Parameters:
TimeValue t - The time to use for the data
Returns
the step scale for the volume.

◆ GetPadding()

virtual float GetPadding ( TimeValue  t)
pure virtual

Query for volume bounds padding amount at the given time.

Parameters:
TimeValue t - The time to use for the data
Returns
the padding amount for the volume bounds.

◆ GetVelOut()

virtual float GetVelOut ( TimeValue  t)
pure virtual

Query for velocity value at the given time.

Parameters:
TimeValue t - The time to use for the data
Returns
the velocity for the volume.

◆ GetVelScale()

virtual float GetVelScale ( TimeValue  t)
pure virtual

Query for velocity scale at the given time.

Parameters:
TimeValue t - The time to use for the data
Returns
the velocity scale for the volume.