#include <c4d_basedocument.h>

Detailed Description

This class allows to perform some functions on all of the objects in a hierarchy.
Example:

struct ExampleStruct
{
  Int32 parent_state;
};
 
class ExampleHierarchy : public Hierarchy
{
public:
  virtual void *Alloc() { return NewObjPtr(ExampleStruct); }
  virtual void Free(void *data) { ExampleStruct *es = (ExampleStruct*)data; DeleteObj(es); }
  virtual void CopyTo(void *src, void *dst) { *(static_cast<ExampleStruct*>(dst)) = *static_cast<ExampleStruct*>(src); }
  virtual Bool Do(void *data, BaseObject *op, const Matrix &mg, Bool controlobject);
};
 
Bool ExampleHierarchy::Do(void *data, BaseObject *op, const Matrix &mg, Bool controlobject)
{
  ExampleStruct* dt = (ExampleStruct*)data;
 
  Int32 mode = op->GetRenderMode();
  if (mode != MODE_UNDEF) // if mode is MODE_ON or MODE_OFF
    d->parent_state = mode;
 
  // Important: Do this parent-data inheritance always, even if you do not evaluate an object
  // Reason: A child of an invisible control object might be visible again...
 
  if (controlobject)
    return true; // This object is not visible, has been used by generator
  if (op->GetType() != Opolygon)
    return true; // We cannot use this
 
  // Do something with polygonized object op
  // The object has matrix mg and local data dt
 
  return true;
}

Public Member Functions
virtual void *	Alloc ()=0

virtual void	Free (void *data)=0

virtual void	CopyTo (void src, void dst)=0

virtual Bool	Do (void data, BaseObject op, const Matrix &mg, Bool controlobject)=0

Bool	Run (BaseDocument doc, Bool spheres, Float lod, Bool uselod, BUILDFLAGS flags, void startdata, BaseThread *bt)

Private Attributes
BaseDocument *	doc

BaseThread *	bt

Member Function Documentation

◆ Alloc()

virtual void* Alloc ( )

pure virtual

Override the method to allocate the private data for a single level in the hierarchy.
Cinema 4D itself will pass the parent matrix but all other data that might be needed must be passed down the hierarchy using a private data structure and this is where it is allocated.

Returns: The private data that is allocated.

◆ Free()

virtual void Free ( void * data )

pure virtual

Override the method so that the private data allocated in Alloc() can be freed.

Parameters

[in,out] data The private data to free.

◆ CopyTo()

virtual void CopyTo	(	void *	src,
		void *	dst
	)

pure virtual

Override the method so that the private data can be copied.

Parameters

[in]	src	The source private data to copy from.
[out]	dst	The destination private data to copy to.

◆ Do()

virtual Bool Do	(	void *	data,
		BaseObject *	op,
		const Matrix &	mg,
		Bool	controlobject
	)

pure virtual

Override the method to be called for every object, virtual and non-virtual, in the hierarchy run.

Parameters

[in]	data	The private data allocated in Alloc().
[in]	op	The object the function is being called for.
[in]	mg	The global matrix for this object down the hierarchy chain.
[in]	controlobject	If true then the object has been used by a generator and usually will no longer be used (but the routine goes through all objects in any case).

Returns: true if the function was successful and the run through the hierarchy should continue, otherwise false.

◆ Run()

Bool Run	(	BaseDocument *	doc,
		Bool	spheres,
		Float	lod,
		Bool	uselod,
		BUILDFLAGS	flags,
		void *	startdata,
		BaseThread *	bt
	)

Performs Do() on all objects (virtual and non-virtual) in the hierarchy.
Using this class will build all caches for dirty objects for the entire hierarchy, this can be time intensive and should be used carefully.
If a polygon object is needed it is generally faster to call SendModelingCommand() with MCOMMAND_CURRENTSTATETOOBJECT.

Parameters

[in]	doc	The document with the objects you want to process.
[in]	spheres	If true the process will not polygonize perfect spheres.
[in]	lod	The level of detail to use.
[in]	uselod	If true the level of detail lod should be evaluated.
[in]	flags	The build flags are: BUILDFLAGS Note: Either BUILDFLAGS::INTERNALRENDERER or BUILDFLAGS::EXTERNALRENDERER must be set because some generators check for these flags and generate different results. For example the Metaball object has different settings in the edit dialog for internal and external rendering.
[in]	startdata	The initial private data to pass into the hierarchy.
[in]	bt	The custom thread, or nullptr if called from the main Cinema 4D thread.