#include <lib_hair.h>

Inheritance diagram for HairObject:

[legend]

Detailed Description

Hair object.

Note: Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Public Member Functions
Bool	Lock (BaseDocument pDoc, BaseThread pThread, Bool bValidate, Int32 flags)

Bool	IsLocked ()

void	Unlock ()

HairGuides *	GetGuides ()

HairGuides *	GetDynamicGuides ()

HairGuides *	GenerateHair (Int32 flags=0, Int32 count=NOTOK, Int32 segments=NOTOK, HairMaterialData *pMaterial=nullptr, HairInterpolationMap pMap=nullptr)

Bool	GetRootObject (BaseObject pObject, BaseTag pTag, RootObjectData *pData)

Bool	SetGuides (HairGuides *guides, Bool clone)

void	RemoveGuides ()

Bool	Update (BaseDocument *doc)

HairMaterialData *	InitMaterials (const InitRenderStruct &irs, BaseDocument pDoc, HairGuides guides=nullptr, VolumeData *vd=nullptr)

void	FreeMaterials (HairMaterialData *&pMaterials)

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
static HairObject *	Alloc ()

static void	Free (HairObject *&pObject)

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)

Private Member Functions
	HairObject ()

	~HairObject ()

Additional Inherited Members
Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ HairObject()

HairObject ( )

private

◆ ~HairObject()

~HairObject ( )

private

Member Function Documentation

◆ Alloc()

static HairObject* Alloc ( )

static

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

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

◆ Free()

static void Free ( HairObject *& pObject )

static

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

Parameters

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

◆ Lock()

Bool Lock	(	BaseDocument *	pDoc,
		BaseThread *	pThread,
		Bool	bValidate,
		Int32	flags
	)

Locks the hair object.

Parameters

[in]	pDoc	The document.
[in]	pThread	The thread.
[in]	bValidate	Validate the lock.
[in]	flags	Lock flags: HAIR_LOCK_FLAGS

Returns: true if successful, otherwise false.

◆ IsLocked()

Bool IsLocked ( )

Checks if the hair object is locked.

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

◆ Unlock()

void Unlock ( )

Unlocks the hair object.

◆ GetGuides()

HairGuides* GetGuides ( )

Gets the guides of the hair object.

Returns: The guides.

◆ GetDynamicGuides()

HairGuides* GetDynamicGuides ( )

Gets the dynamic guides of the hair object.

Returns: The dynamic guides.

◆ GenerateHair()

HairGuides* GenerateHair	(	Int32	flags = `0`,
		Int32	count = `NOTOK`,
		Int32	segments = `NOTOK`,
		HairMaterialData **	pMaterial = `nullptr`,
		HairInterpolationMap *	pMap = `nullptr`
	)

Generates hair for the hair object.

Parameters

[in]	flags	The generate flags: HAIR_GENERATE_FLAGS
[in]	count	The hair count.
[in]	segments	The segments.
[out]	pMaterial	Filled with material data if not nullptr.
[in]	pMap	Optional hair interpolation map.

Returns: The generated hair.

◆ GetRootObject()

Bool GetRootObject	(	BaseObject **	pObject,
		BaseTag **	pTag,
		RootObjectData *	pData
	)

Gets the root object for the hair object.

Parameters

[out]	pObject	Assigned the root object.
[out]	pTag	Assigned the tag.
[out]	pData	Assigned the root object data.

Returns: true if successful, otherwise false.

◆ SetGuides()

Bool SetGuides	(	HairGuides *	guides,
		Bool	clone
	)

Sets guides for the hair object.

Parameters

[in]	guides	The guides to set.
[in]	clone	true to clone the supplied guides.

Returns: true if successful, otherwise false.

◆ RemoveGuides()

void RemoveGuides ( )

Removes the guides of the hair object.

◆ Update()

Bool Update ( BaseDocument * doc )

Updates the hair object.

Note: Do not use within a Lock().

Parameters

[in] doc The document.

Returns: true if successful, otherwise false.

◆ InitMaterials()

HairMaterialData* InitMaterials	(	const InitRenderStruct &	irs,
		BaseDocument *	pDoc,
		HairGuides *	guides = `nullptr`,
		VolumeData *	vd = `nullptr`
	)

Initializes materials.

Parameters

[in]	irs	Optional InitRenderStruct.
[in]	pDoc	The document.
[in]	guides	Optional guide data.
[in]	vd	Optional VolumeData.

Returns: The initialized material data.

◆ FreeMaterials()

void FreeMaterials ( HairMaterialData *& pMaterials )

Frees materials.

Parameters

[in,out] pMaterials The material data to free.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ HairObject()

◆ ~HairObject()

Member Function Documentation

◆ Alloc()

◆ Free()

◆ Lock()

◆ IsLocked()

◆ Unlock()

◆ GetGuides()

◆ GetDynamicGuides()

◆ GenerateHair()

◆ GetRootObject()

◆ SetGuides()

◆ RemoveGuides()

◆ Update()

◆ InitMaterials()

◆ FreeMaterials()