Base class for translating the object referenced by a node instancing pool. More...

#include <BaseTranslator_Object.h>

Inheritance diagram for BaseTranslator_Object:

Public Member Functions
	BaseTranslator_Object (const std::shared_ptr< const TranslationHelpers::INodeInstancingPool > &nodePool, TranslatorGraphNode &graphNode)

	~BaseTranslator_Object ()

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

virtual void	PreTranslate (const TimeValue translationTime, Interval &validity) override
	Called just before Translate() to enable pre-processing of any kind. 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...

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

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

Protected Member Functions
INode *	GetNode () const
	Returns the node from which the object is evaluated. More...

std::shared_ptr< const TranslationHelpers::INodeInstancingPool >	GetNodePool () const
	Returns the node instancing pool being handled by this translator. More...

virtual bool	CareAboutMaterialDisplacement () const =0
	Returns whether this translator takes into account displacement properties from the material. More...

virtual void	NotifyPoolInstancedObjectChanged (const TranslationHelpers::INodeInstancingPool &node_pool, const NodeEventType event_type) override
	Notifies that the object, being instanced by the pool, has changed and needs to be re-translated. More...

virtual void	NotifyPoolContentMaybeChanged (const TranslationHelpers::INodeInstancingPool &node_pool) override
	Notifies that the set of nodes, contained in the pool, may have changed. 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 ()

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

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

Base class for translating the object referenced by a node instancing pool.

This base class provides basic, common functionality related to translating the object referenced by an INode. It handles:

Monitoring the node instancing pool and invalidating the translator on any changes.
Calling RenderBegin() on the INode before translation.

Constructor & Destructor Documentation

◆ BaseTranslator_Object()

BaseTranslator_Object	(	const std::shared_ptr< const TranslationHelpers::INodeInstancingPool > &	nodePool,
		TranslatorGraphNode &	graphNode
	)

Parameters

nodePool	The node instancing pool from which the object is to be evaluated.
graphNode	The graph node to be passed to Translator::Translator().

◆ ~BaseTranslator_Object()

~BaseTranslator_Object ( )

Member Function Documentation

◆ CheckValidity()

virtual Interval CheckValidity	(	const TimeValue	t,
		const Interval &	previous_validity
	)		const

overridevirtual

Deferred checks whether this translator should be invalidated.

Used in combination with a call to Invalidate(true), this method is called when checking the scene validity to see if this translator should be deferred invalidated. Deferred invalidation is necessary if the translator requires access to the scene to determine if it is in fact invalid. Accessing the scene within notification callbacks is generally unsafe, as some notifications are sent while the scene is in an intermediate state.

Parameters

t	The time at which the validity check is performed.
previous_validity	The current validity interval interval of the translator.

Returns: The new validity interval of the translator; empty if the translator is to be invalidated outright. Return previous_validity to leave the translator's validity as-is.

Implements Translator.

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

Implements Translator.

◆ PostTranslate()

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

overridevirtual

Called just after Translate() to enable post-processing of any kind.

The principle is identical to that of PreTranslate(), except that this method is called immediately after the call to Translate().

Parameters

	translationTime	The time at which Translate() was just 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.

Remarks: This method is called regardless of the return value of Translate().

Implements Translator.

◆ GetNode()

INode* GetNode ( ) const

protected

Returns the node from which the object is evaluated.

This node is extracted from the node instancing pool, through INodeInstancingPool::GetRepresentativeNode().

◆ GetNodePool()

std::shared_ptr<const TranslationHelpers::INodeInstancingPool> GetNodePool ( ) const

protected

Returns the node instancing pool being handled by this translator.

◆ CareAboutMaterialDisplacement()

virtual bool CareAboutMaterialDisplacement ( ) const

protectedpure virtual

Returns whether this translator takes into account displacement properties from the material.

That is, whether a change in the material's displacement properties should cause this translator to be invalidated.

◆ NotifyPoolInstancedObjectChanged()

virtual void NotifyPoolInstancedObjectChanged	(	const TranslationHelpers::INodeInstancingPool &	node_pool,
		const NodeEventType	event_type
	)

overrideprotectedvirtual

Notifies that the object, being instanced by the pool, has changed and needs to be re-translated.

For example, would be called if the mesh of the instanced object were to change.

Parameters

node_pool	The pool which is sending the notification.
event_type	The type of event that triggered this notification.

Implements INodeInstancingPool::INotifier.

◆ NotifyPoolContentMaybeChanged()

virtual void NotifyPoolContentMaybeChanged ( const TranslationHelpers::INodeInstancingPool & node_pool )

overrideprotectedvirtual

Notifies that the set of nodes, contained in the pool, may have changed.

This method notifies that some nodes may have been added or removed to/from the pool. We say may have changed, because it's impossible to know for sure at this point due to node evaluations being disallowed (unsafe) in notification callbacks. The listener should use a deferred validity check (i.e. call Translator::Invalidte(true)) and later re-acquire the pool for the node being cared for. This re-acquisition of the pool will cause the nodes to be re-evaluated and the pools to be re-built accordingly.

Parameters

node_pool The pool which is sending the notification.

Implements INodeInstancingPool::INotifier.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTranslator_Object()

◆ ~BaseTranslator_Object()

Member Function Documentation

◆ CheckValidity()

◆ PreTranslate()

◆ PostTranslate()

◆ GetNode()

◆ GetNodePool()

◆ CareAboutMaterialDisplacement()

◆ NotifyPoolInstancedObjectChanged()

◆ NotifyPoolContentMaybeChanged()