#include <lib_cloud.h>

Inheritance diagram for CloudObject:

[legend]

Detailed Description

Cloud object.

Private Member Functions
	CloudObject ()

	~CloudObject ()

Alloc/Free
static CloudObject *	Alloc ()

static void	Free (CloudObject *&pObj)

Miscellaneous
static void	SetDrawHook (CloudDrawFn fn)

void *	GetPrivateData (CloudDataAllocator fnAlloc, ClodDataDeleter fnFree)

Size/Density
void	GetSize (Vector &vSize)

void	GetSize (Int32 &x, Int32 &y, Int32 &z)

UChar *	GetDensity ()

Int	GetDensitySize ()

Bool	Resize (Int32 x, Int32 y, Int32 z, Bool bResample)

Tool Data
UChar *	GetToolData ()

Bool	AllocToolData ()

void	FreeToolData ()

Altitude
Float	GetAltitude (BaseObject *pCloudGroup)

Smooth/Clear/Fill
Bool	SmoothBorders (Float rDist, Float rVariance, SplineData *pSpline)

Bool	SmoothAll (Float rStrength, Float rVariance)

void	Clear (UChar chDensity)

void	FillPlane (Float rRadius, UChar chDensity)

void	FillSphere (Float rRadius, UChar chDensity)

Visible/Lock
Bool	IsVisible (Bool bEditor, Bool &bDrawBox, BaseObject &pSkyObject, BaseObject *ppGroup=nullptr)

Bool	IsLocked ()

Draw
void	Draw (BaseDraw pBaseDraw, BaseDrawHelp pDrawHelp, Int32 lGrid, Float rQuality, Bool bDrawPlane)

Plane Index/Position
Int32	GetPlaneIndex ()

void	SetPlaneIndex (Int32 lPlane)

Int32	GetPlanePosition ()

void	SetPlanePosition (Int32 lPos)

Additional Inherited Members
Public Member Functions inherited from BaseObject
BaseObject *	GetNext ()

BaseObject *	GetPred ()

BaseObject *	GetUp ()

BaseObject *	GetDown ()

BaseObject *	GetDownLast ()

Vector	GetAbsPos () const

void	SetAbsPos (const Vector &v)

Vector	GetAbsScale () const

void	SetAbsScale (const Vector &v)

Vector	GetAbsRot () const

void	SetAbsRot (const Vector &v)

Vector	GetFrozenPos () const

void	SetFrozenPos (const Vector &v)

Vector	GetFrozenScale () const

void	SetFrozenScale (const Vector &v)

Vector	GetFrozenRot () const

void	SetFrozenRot (const Vector &v)

Vector	GetRelPos () const

void	SetRelPos (const Vector &v)

Vector	GetRelScale () const

void	SetRelScale (const Vector &v)

Vector	GetRelRot () const

void	SetRelRot (const Vector &v)

const Matrix &	GetMl () const

void	SetMl (const Matrix &m)

Matrix	GetFrozenMln () const

Matrix	GetRelMln () const

Matrix	GetRelMl () const

void	SetRelMl (const Matrix &m)

Matrix	GetMg () const

void	SetMg (const Matrix &m)

Matrix	GetMln () const

Matrix	GetMgn () const

Matrix	GetUpMg () const

void	CopyMatrixTo (BaseObject *dst)

Vector	GetMp ()

Vector	GetRad ()

void	GetDimension (Vector &mp, Vector &rad)

Int32	GetEditorMode () const

Int32	GetEditorModeH () const

void	SetEditorMode (Int32 mode)

Int32	GetRenderMode () const

Int32	GetRenderModeH () const

void	SetRenderMode (Int32 mode)

Bool	GetDeformMode () const

void	SetDeformMode (Bool mode)

Int32	GetRealDeformMode () const

void	SetRealDeformMode (Int32 mode)

Int32	GetUniqueIP ()

void	SetUniqueIP (Int32 ip)

BaseTag *	GetFirstTag ()

BaseTag *	GetLastTag ()

BaseTag *	GetTag (Int32 type, Int32 nr=0)

const maxon::BaseArray< BaseTag * > *	GetTagsOfType (Int32 type) const

const maxon::BaseArray< BaseTag * > *	GetTagsWithFlags (Int32 flags) const

const void *	GetTagDataR (Int32 type, Int32 nr=0) const

void *	GetTagDataW (Int32 type, Int32 nr=0)

Int32	GetTagDataCount (Int32 type) const

BaseTag *	MakeTag (Int32 type, BaseTag *pred=nullptr)

VariableTag *	MakeVariableTag (Int32 type, Int32 count, BaseTag *pred=nullptr)

void	InsertTag (BaseTag tp, BaseTag pred=nullptr)

void	KillTag (Int32 type, Int32 nr=0)

Bool	CopyTagsTo (BaseObject dest, Int32 visible, Int32 variable, Int32 hierarchical, AliasTrans trans)

BaseObject *	GetCache (HierarchyHelp *hh=nullptr)

BaseObject *	GetDeformCache ()

LineObject *	GetIsoparm ()

void	SetIsoparm (LineObject *l)

BaseObject *	GetCacheParent () const

BaseObject *	GetCacheTopParent () const

Bool	SetPhong (Bool on, Bool anglelimit, Float angle)

Bool	IsDirty (DIRTYFLAGS flags)

void	SetDirty (DIRTYFLAGS flags)

Bool	CheckCache (HierarchyHelp *hh)

void	Touch ()

void	GetColorProperties (ObjectColorProperties *prop)

void	SetColorProperties (ObjectColorProperties *prop)

const Matrix &	GetModelingAxis (BaseDocument *doc)

void	SetModelingAxis (const Matrix &m)

BaseObject *	GetAndCheckHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Int childCount, maxon::BaseArray< BaseObject * > *children, Bool addChildOrClone=false)

BaseObject *	GetAndCheckHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Bool allchildren)

BaseObject *	GetHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans)

BaseObject *	GetHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, DIRTYFLAGS dirtyflags)

void	NewDependenceList ()

Bool	CompareDependenceList ()

void	AddDependence (HierarchyHelp hh, BaseObject op)

void	AddDependence (HierarchyHelp hh, BaseObject op, DIRTYFLAGS dirtyflags)

void	TouchDependenceList ()

void	SetRotationOrder (ROTATIONORDER order)

ROTATIONORDER	GetRotationOrder () const

void	SetQuaternionRotationMode (Bool active, Bool bUndo)

Bool	IsQuaternionRotationMode ()

Bool	SynchronizeVectorTrackKeys (Int32 vectorTrackID, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	FindBestEulerAngle (Int32 rotationTrackID, Bool bAdjustTangent, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	EvaluateSynchronizedRotation (const BaseTime &time, ANIMATEFLAGS flags, Vector *resultRotation=nullptr)

Bool	GetVectorTracks (const DescID &id, CTrack &xfound, CTrack &yfound, CTrack *&zfound)

Bool	GetVectorCurves (CCurve curveToSearch, CCurve &xfound, CCurve &yfound, CCurve &zfound)

UInt64	GetGUID ()

Int32	GetHighlightHandle (BaseDraw *bd)

SplineObject *	GetRealSpline ()

Float	GetVisibility (Float parent)

Bool	SearchHierarchy (BaseObject *op)

BaseObject *	GetOrigin (Bool safe)

void	SetOrigin (BaseObject *origin)

BaseObject *	GetTopOrigin (Bool parent, Bool safe)

BaseObject *	GetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true)

void	RemoveFromCache ()

DRAWRESULT	ObjDraw (DRAWPASS drawpass, BaseDraw bd, BaseDrawHelp bh)

Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

BaseList2D *	GetPred ()

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

String	GetName () const

void	SetName (const maxon::String &name)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot ()

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName ()

BaseList2D *	GetMain () const

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot ()

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot ()

GeListHead *	GetHiddenShaderRoot ()

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () const

void	SetMarker (const GeMarker &m)

Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)

Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const

Int32	GetUniqueIDCount () const

Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const

Bool	SetAnimatedParameter (CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (BaseDocument *doc)

Bool	SetLayerObject (LayerObject *layer)

const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot ()

CTrack *	GetFirstCTrack ()

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

GeListNode *	GetPred ()

GeListNode *	GetDown ()

GeListNode *	GetUp ()

GeListNode *	GetDownLast ()

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

GeListHead *	GetListHead ()

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

BaseDocument *	GetDocument ()

Int32	GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)

Bool	IsDocumentRelated ()

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn)

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn)

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf)

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf)

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags)

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescription ()

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Static Public Member Functions inherited from BaseObject
static BaseObject *	Alloc (Int32 type)

static void	Free (BaseObject *&bl)

Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ CloudObject()

CloudObject ( )

private

◆ ~CloudObject()

~CloudObject ( )

private

Member Function Documentation

◆ Alloc()

static CloudObject* Alloc ( )

static

Allocates a cloud object. Destroy the allocated cloud object with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns: The allocated cloud object, or nullptr if the allocation failed.

◆ Free()

static void Free ( CloudObject *& pObj )

static

Destructs cloud objects allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out] pObj The cloud object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetSize() [1/2]

void GetSize ( Vector & vSize )

Retrieves the size in the vector vSize.

Parameters

[out] vSize The size.

◆ GetSize() [2/2]

void GetSize	(	Int32 &	x,
		Int32 &	y,
		Int32 &	z
	)

Retrieves the grid size.

Note: The cloud has (x + 1) * (y + 1) * (z + 1) grid points.

Parameters

[out]	x	Assigned the X size.
[out]	y	Assigned the Y size.
[out]	z	Assigned the Z size.

◆ GetDensity()

UChar* GetDensity ( )

Gets the density array.

Returns: The density array.

◆ GetDensitySize()

Int GetDensitySize ( )

Gets the density size.

Returns: The density size.

◆ Resize()

Bool Resize	(	Int32	x,
		Int32	y,
		Int32	z,
		Bool	bResample
	)

Resizes the cloud object.

Parameters

[in]	x	The new X size.
[in]	y	The new Y size.
[in]	z	The new Z size.
[in]	bResample	If true the cloud data is resampled.

Returns: true if successful, otherwise false.

◆ GetToolData()

UChar* GetToolData ( )

Gets the tool data.

Returns: The tool data.

◆ AllocToolData()

Bool AllocToolData ( )

Allocates the tool data.

Returns: true if successful, otherwise false.

◆ FreeToolData()

void FreeToolData ( )

Frees the tool data.

◆ GetAltitude()

Float GetAltitude ( BaseObject * pCloudGroup )

Gets the altitude of a cloud group.

Parameters

[in] pCloudGroup The cloud group object. The caller owns the pointed object.

Returns: The altitude.

◆ SmoothBorders()

Bool SmoothBorders	(	Float	rDist,
		Float	rVariance,
		SplineData *	pSpline
	)

Smooths borders.

Parameters

[in]	rDist	The distance.
[in]	rVariance	The variance.
[in]	pSpline	The spline to smooth along.

Returns: true if successful, otherwise false.

◆ SmoothAll()

Bool SmoothAll	(	Float	rStrength,
		Float	rVariance
	)

Smooths all of the cloud object.

Parameters

[in]	rStrength	The strength.
[in]	rVariance	The variance.

Returns: true if successful, otherwise false.

◆ Clear()

void Clear ( UChar chDensity )

Clears the cloud object to chDensity.

Parameters

[in] chDensity The clear density.

◆ FillPlane()

void FillPlane	(	Float	rRadius,
		UChar	chDensity
	)

Fills the plane.

Parameters

[in]	rRadius	The radius.
[in]	chDensity	The density.

◆ FillSphere()

void FillSphere	(	Float	rRadius,
		UChar	chDensity
	)

Fills a sphere.

Parameters

[in]	rRadius	The radius.
[in]	chDensity	The density.

◆ IsVisible()

Bool IsVisible	(	Bool	bEditor,
		Bool &	bDrawBox,
		BaseObject *&	pSkyObject,
		BaseObject **	ppGroup = `nullptr`
	)

Checks for visibility.

Parameters

[in]	bEditor	The editor mode.
[out]	bDrawBox	Assigned the draw box visibility.
[out]	pSkyObject	Assigned the sky object.
[in]	ppGroup	Optional array of cloud groups.

Returns: true if visible, otherwise false.

◆ IsLocked()

Bool IsLocked ( )

Checks if the cloud object is locked.

Returns: true if the cloud object is locked, otherwise false.

◆ Draw()

void Draw	(	BaseDraw *	pBaseDraw,
		BaseDrawHelp *	pDrawHelp,
		Int32	lGrid,
		Float	rQuality,
		Bool	bDrawPlane
	)

Draws the cloud object.

Parameters

[in]	pBaseDraw	The draw view.
[in]	pDrawHelp	The draw helper.
[in]	lGrid	The grid size.
[in]	rQuality	The quality.
[in]	bDrawPlane	The draw plane option.

◆ GetPlaneIndex()

Int32 GetPlaneIndex ( )

Gets the plane index.

Returns: The plane index.

◆ SetPlaneIndex()

void SetPlaneIndex ( Int32 lPlane )

Sets the plane index.

Parameters

[in] lPlane The new plane index.

◆ GetPlanePosition()

Int32 GetPlanePosition ( )

Gets the plane position.

Returns: The plane position.

◆ SetPlanePosition()

void SetPlanePosition ( Int32 lPos )

Sets the plane position.

Parameters

[in] lPos The new plane position.

◆ GetPrivateData()

void* GetPrivateData	(	CloudDataAllocator	fnAlloc,
		ClodDataDeleter	fnFree
	)

Retrieves the cloud private data.

Parameters

[in]	fnAlloc	The data allocator hook.
[in]	fnFree	The data deleter hook.

Returns: The private data.

◆ SetDrawHook()

static void SetDrawHook ( CloudDrawFn fn )

static

Sets the cloud draw hook.

Parameters

[in] fn The draw hook.

Detailed Description

Private Member Functions

Alloc/Free

Miscellaneous

Size/Density

Tool Data

Altitude

Smooth/Clear/Fill

Visible/Lock

Draw

Plane Index/Position

Additional Inherited Members

Constructor & Destructor Documentation

◆ CloudObject()

◆ ~CloudObject()

Member Function Documentation

◆ Alloc()

◆ Free()

◆ GetSize() [1/2]

◆ GetSize() [2/2]

◆ GetDensity()

◆ GetDensitySize()

◆ Resize()

◆ GetToolData()

◆ AllocToolData()

◆ FreeToolData()

◆ GetAltitude()

◆ SmoothBorders()

◆ SmoothAll()

◆ Clear()

◆ FillPlane()

◆ FillSphere()

◆ IsVisible()

◆ IsLocked()

◆ Draw()

◆ GetPlaneIndex()

◆ SetPlaneIndex()

◆ GetPlanePosition()

◆ SetPlanePosition()

◆ GetPrivateData()

◆ SetDrawHook()