#include <c4d_particles.h>

Inheritance diagram for TP_PGroup:

[legend]

Detailed Description

Represents a particle group.

Public Member Functions
Int32	GetLevel ()

TP_ParticleNode *	GetFirstNode ()

const TP_ParticleNode *	GetFirstNode () const

TP_ParticleNode *	GetLastNode ()

Int32	NumParticles ()

Bool	IsSubGroup (TP_PGroup *group)

Int32	GetGroupID ()

const String	GetTitle ()

void	SetTitle (const maxon::String &title)

Int32	GetViewType ()

void	SetViewType (Int32 type)

Bool	GetShowObjects ()

void	SetShowObjects (Bool show)

Vector	GetColor ()

void	SetColor (Vector &col)

Bool	EditSettings ()

Bool	IsSelected ()

Bool	IsOpened ()

void	Select (Int32 mode)

void	Open (Bool onoff)

void	SetUseColor (Bool useCol)

Bool	GetUseColor ()

void	Cache (Bool onoff)

Bool	IsCache ()

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 ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData ()

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

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

BaseList2D *	GetMain () const

void	InsertTrackSorted (CTrack *track)

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

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

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

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

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

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

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

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

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 (const 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) const

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 (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

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

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

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

CTrack *	GetFirstCTrack ()

const CTrack *	GetFirstCTrack () const

CTrack *	FindCTrack (const DescID &id)

const CTrack *	FindCTrack (const DescID &id) const

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

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 ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

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) const

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

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

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

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

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

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

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

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)

Private Member Functions
	TP_PGroup ()

	~TP_PGroup ()

Additional Inherited Members
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

◆ TP_PGroup()

TP_PGroup ( )

private

◆ ~TP_PGroup()

~TP_PGroup ( )

private

Member Function Documentation

◆ GetLevel()

Int32 GetLevel ( )

Calculates the level of the group. This is the number of parents that the group has.

Returns: The group level.

◆ GetFirstNode() [1/2]

TP_ParticleNode* GetFirstNode ( )

Gets the first node in the particle list of the group.

Returns: The first node. The list owns the pointed TP_ParticleNode.

◆ GetFirstNode() [2/2]

const TP_ParticleNode* GetFirstNode ( ) const

◆ GetLastNode()

TP_ParticleNode* GetLastNode ( )

Gets the last node in the particle list of the group.

Returns: The last node. The list owns the pointed TP_ParticleNode.

◆ NumParticles()

Int32 NumParticles ( )

Calculates the number of particles in the group.

Returns: The particle count.

◆ IsSubGroup()

Bool IsSubGroup ( TP_PGroup * group )

Checks if group is a subgroup of the group.

Parameters

[in] group A group. The caller owns the pointed TP_PGroup.

Returns: true if group is a subgroup of the group, otherwise false.

◆ GetGroupID()

Int32 GetGroupID ( )

Gets the ID of the group. This is only based on the order in the group list, so it can change when the user reorders the groups.

Returns: The group ID.

◆ GetTitle()

const String GetTitle ( )

Gets the group title.

Returns: The group title.

◆ SetTitle()

void SetTitle ( const maxon::String & title )

Sets the group title.

Parameters

[in] title The new group title.

◆ GetViewType()

Int32 GetViewType ( )

Gets the group view type.

Returns: The view type. See PGROUP_VIEWTYPE in description/tp_group.h.

◆ SetViewType()

void SetViewType ( Int32 type )

Sets the group view type.

Parameters

[in] type The new view type. See PGROUP_VIEWTYPE in description/tp_group.h.

◆ GetShowObjects()

Bool GetShowObjects ( )

Gets the show-objects flag of the group.

Returns: The show-objects flag.

◆ SetShowObjects()

void SetShowObjects ( Bool show )

Sets the show-objects flag of the group.

Parameters

[in] show The new show-objects flag.

◆ GetColor()

Vector GetColor ( )

Gets the color of the group.

Returns: The group color.

◆ SetColor()

void SetColor ( Vector & col )

Sets the color of the group.

Parameters

[in] col The new group color.

◆ EditSettings()

Bool EditSettings ( )

Opens the edit dialog for the group.

Returns: true if the user clicked OK, otherwise false.

◆ IsSelected()

Bool IsSelected ( )

Checks if the group is selected in the group list.

Returns: true if the group is selected, otherwise false.

◆ IsOpened()

Bool IsOpened ( )

Checks if the group is opened in the group list.

Returns: true if the group is opened, otherwise false.

◆ Select()

void Select ( Int32 mode )

Sets the selection mode of the group in the group list.

Parameters

[in] mode The selection mode: SELECTION

◆ Open()

void Open ( Bool onoff )

Opens or closes the group in the group list.

Parameters

[in] onoff true if the group should be opened, otherwise false.

◆ SetUseColor()

void SetUseColor ( Bool useCol )

Sets the use color state of the group.

Since: R16.038

Parameters

[in] useCol true if use color should be enabled, otherwise false.

◆ GetUseColor()

Bool GetUseColor ( )

Gets the use color state of the group.

Since: R16.038

Returns: true if use color is enabled, otherwise false.

◆ Cache()

void Cache ( Bool onoff )

Sets the group to contain only cached data. This will prevent the particle system from doing simulation calculations for the group.

Since: R16.050

Parameters

[in] onoff true if cached data is used, otherwise false.

◆ IsCache()

Bool IsCache ( )

Checks if the group is used to represent cached particle data only.

Since: R16.050

Returns: true if the group represents cached data, otherwise false.

Detailed Description

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TP_PGroup()

◆ ~TP_PGroup()

Member Function Documentation

◆ GetLevel()

◆ GetFirstNode() [1/2]

◆ GetFirstNode() [2/2]

◆ GetLastNode()

◆ NumParticles()

◆ IsSubGroup()

◆ GetGroupID()

◆ GetTitle()

◆ SetTitle()

◆ GetViewType()

◆ SetViewType()

◆ GetShowObjects()

◆ SetShowObjects()

◆ GetColor()

◆ SetColor()

◆ EditSettings()

◆ IsSelected()

◆ IsOpened()

◆ Select()

◆ Open()

◆ SetUseColor()

◆ GetUseColor()

◆ Cache()

◆ IsCache()