Base class for translating a MtlBase. More...

#include <BaseTranslator_MtlBase.h>

Inheritance diagram for BaseTranslator_MtlBase:

Public Member Functions
	BaseTranslator_MtlBase (MtlBase *mtl, const bool monitor_mtl_base, TranslatorGraphNode &graphNode)

	~BaseTranslator_MtlBase ()

virtual void	PreTranslate (const TimeValue translationTime, Interval &validity) override
	Called just before Translate() to enable pre-processing of any kind. More...

virtual MSTR	GetTimingCategory () const override
	Returns the string label to be used by the time reporting mechanism. More...

Public Member Functions inherited from BaseTranslator_ReferenceTarget
	BaseTranslator_ReferenceTarget (ReferenceTarget *reference_target, const bool monitor_reference_target, TranslatorGraphNode &graphNode)

	~BaseTranslator_ReferenceTarget ()

virtual Interval	CheckValidity (const TimeValue t, const Interval &previous_validity) const override
	Deferred checks whether this translator should be invalidated. More...

virtual void	PostTranslate (const TimeValue translationTime, Interval &validity) override
	Called just after Translate() to enable post-processing of any kind. More...

Public Member Functions inherited from Translator
	Translator (TranslatorGraphNode &graphNode)
	The constructor expects a reference to a TranslatorGraphNode. More...

virtual	~Translator ()

virtual TranslationResult	Translate (const TimeValue translationTime, Interval &newValidity, ITranslationProgress &translationProgress, KeyframeList &keyframesNeeded)=0
	Performs the translation for which this class is responsible. More...

virtual TranslationResult	TranslateKeyframe (const TimeValue frame_time, const TimeValue keyframe_time, ITranslationProgress &translationProgress)=0
	Performs translation for a single keyframe. More...

virtual void	AccumulateStatistics (TranslatorStatistics &stats) const =0
	Called by the system to accumulate statistics on the translated scene. More...

void	AccumulateGraphStatistics (TranslatorStatistics &statistics) const
	Accumulates statistics on the whole translate graph, starting at this translation node. More...

TranslatorGraphNode &	GetGraphNode () const
	For internal use. More...

Static Public Member Functions
static void	UpdateMaterialHierarchy (MtlBase &mtlBase, const TimeValue t, Interval &validity)
	Calls MtlBase::Update() and Texmap::LoadMapFiles() on the given material/texmap and its sub-tree of materials and textures. More...

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...

Protected Member Functions
MtlBase *	GetMtlBase () const
	Returns the MtlBase being handled by this translator. More...

Protected Member Functions inherited from BaseTranslator_ReferenceTarget
ReferenceTarget *	GetReferenceTarget () const
	Returns the ReferenceTarget being handled by this class. More...

virtual void	NotificationCallback_NotifyEvent (const IGenericEvent &genericEvent, void *userData) override
	Called to process an event. More...

Protected Member Functions inherited from Translator
template<typename TranslatorType >
const TranslatorType *	AcquireChildTranslator (const TranslatorKey &key, const TimeValue t, ITranslationProgress &translation_progress, TranslationResult &result)
	Acquires a dependency to a another translator and its outputs. More...

void	Invalidate (const bool defer_invalidation_check=false)
	Invalidates this translator, typically as a result of a change notification callback. More...

void	InvalidateParents ()
	Invalidates all parents of this translator. More...

void	TranslatedObjectDeleted ()
	Flags the objects/inputs, being translated by this translated, as having been deleted. More...

IRenderSessionContext &	GetRenderSessionContext ()
	Returns the render session context for which this translator was created. More...

const IRenderSessionContext &	GetRenderSessionContext () const
	Returns the render session context for which this translator was created. More...

size_t	GetNumOutputs () const
	Returns the number of outputs that are present on this translator. More...

template<typename OutputType >
std::shared_ptr< const OutputType >	GetOutput (const size_t index) const
	Returns the output at the given index, dynamically cast to the given sub-class of ITranslatorOutput. More...

void	SetNumOutputs (const size_t num)
	Initializes the size of the internal array, used to store the outputs. More...

void	SetOutput (const size_t index, std::shared_ptr< const ITranslatorOutput > output)
	Initializes the output, at the given index, to the given value. More...

void	ResetOutput (const size_t index)
	Deletes the output at the given index, such that GetOutput() will henceforth return null. More...

void	ResetAllOutputs ()
	Deletes all outputs. More...

template<typename SimpleValueType >
void	SetOutput_SimpleValue (const size_t output_index, const SimpleValueType &value)
	Shortcut method to initialize outputs which map to simple types that require no external cleanup code. More...

template<typename SimpleValueType >
SimpleValueType	GetOutput_SimpleValue (const size_t output_index, const SimpleValueType &default_value) const
	Returns an output initialized using SetOutput_SimpleValue(). More...

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Protected Member Functions inherited from INotificationCallback
virtual	~INotificationCallback ()

Additional Inherited Members
Public Types inherited from Translator
typedef std::set< TimeValue >	KeyframeList

Detailed Description

Base class for translating a MtlBase.

This base class provides basic, common functionality related to translating a MtlBase. It handles:

Monitoring the MtlBase and invalidating the translator on any changes.
Calling RenderBegin() on the MtlBase before translation.
Calling MtlBase::Update() and Texmap::LoadMapFiles() on the MtlBase, and its entire refernce sub-hierarchy, before translation.

Constructor & Destructor Documentation

◆ BaseTranslator_MtlBase()

BaseTranslator_MtlBase	(	MtlBase *	mtl,
		const bool	monitor_mtl_base,
		TranslatorGraphNode &	graphNode
	)

Parameters

mtl	The MtlBase to be translated.
monitor_mtl_base	Whether this class should monitor the MtlBase. Set to false if monitoring through the subclass, as something else (e.g. as Mtl*).
graphNode	The graph node to be passed to Translator::Translator().

◆ ~BaseTranslator_MtlBase()

~BaseTranslator_MtlBase ( )

Member Function Documentation

◆ PreTranslate()

virtual void PreTranslate	(	const TimeValue	translationTime,
		Interval &	validity
	)

overridevirtual

Called just before Translate() to enable pre-processing of any kind.

This method is to be used to perform per-processing that needs to happen before Translate() is called. A separate method is needed in case the class hierarchy results in a sub-classes Translate() being called before this class. Example uses of this method include calling IRenderSessionContext::CallRenderBegin() or MtlBase::Update().

Parameters

	translationTime	The time at which Translate() is about to be called.
[in,out]	validity	The validity of the translator, to be intersected with the input value. The translator will be re-translated whenever the current time value falls outside of this validity.

Reimplemented from BaseTranslator_ReferenceTarget.

◆ GetTimingCategory()

virtual MSTR GetTimingCategory ( ) const

overridevirtual

Returns the string label to be used by the time reporting mechanism.

The translation system automatically times every translator for reporting, to the log, a categorized table that shows where translation time is spent. This method returns the label under which this translator's time is reported. Multiple translator classes can use the same label, resulting in their time being added up to a common total. Returning an empty string causes this translator's time to be reported under a "miscellaneous" category.

Implements Translator.

Reimplemented in BaseTranslator_Environment.

◆ UpdateMaterialHierarchy()

static void UpdateMaterialHierarchy	(	MtlBase &	mtlBase,
		const TimeValue	t,
		Interval &	validity
	)

static

Calls MtlBase::Update() and Texmap::LoadMapFiles() on the given material/texmap and its sub-tree of materials and textures.

This generally needs to be called before a material/texmap is used. This method is called automatically by this class (BaseTranslator_MtlBase) before the material is translated, but exposed here in case any external code might need to access it independently.

Parameters

	mtlBase	The material/texmap that forms the root of the material/texmap tree to be updated.
	t	The time at which the material is to be updated.
[in,out]	validity	The validity of the material at the given time, to be intersected with the input value.

◆ GetMtlBase()

MtlBase* GetMtlBase ( ) const

protected

Returns the MtlBase being handled by this translator.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTranslator_MtlBase()

◆ ~BaseTranslator_MtlBase()

Member Function Documentation

◆ PreTranslate()

◆ GetTimingCategory()

◆ UpdateMaterialHierarchy()

◆ GetMtlBase()