TP_PGroup Class Reference

#include <c4d_particles.h>

Inheritance diagram for TP_PGroup:

Detailed Description

Represents a particle group.

Public Member Functions

Int32 GetLevel (void)
 
TP_ParticleNodeGetFirstNode (void)
 
TP_ParticleNodeGetLastNode (void)
 
Int32 NumParticles (void)
 
Bool IsSubGroup (TP_PGroup *group)
 
Int32 GetGroupID (void)
 
const String GetTitle (void)
 
void SetTitle (const maxon::String &title)
 
Int32 GetViewType (void)
 
void SetViewType (Int32 type)
 
Bool GetShowObjects (void)
 
void SetShowObjects (Bool show)
 
Vector GetColor (void)
 
void SetColor (Vector &col)
 
Bool EditSettings (void)
 
Bool IsSelected (void)
 
Bool IsOpened (void)
 
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
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
 
BaseList2DGetNext ()
 
BaseList2DGetPred ()
 
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)
 
BaseContainer GetData ()
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance () const
 
BaseContainerGetDataInstance ()
 
const BaseContainerGetDataInstanceRef () const
 
BaseContainerGetDataInstanceRef ()
 
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)
 
GeListHeadGetNLARoot ()
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
String GetTypeName ()
 
BaseList2DGetMain () 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
 
GeListHeadGetOverrideRoot ()
 
BaseOverrideGetFirstOverride ()
 
GeListHeadGetShaderRepositoryRoot ()
 
GeListHeadGetHiddenShaderRoot ()
 
maxon::NimbusInterface * GetNimbusRef (const maxon::Id &spaceId) const
 
maxon::Result< maxon::NimbusInterface * > GetOrCreateNimbusRef (const maxon::Id &spaceId)
 
void RemoveNimbusRef (const maxon::Id &spaceId)
 
maxon::Result< maxon::HashMap< maxon::Id, maxon::ForwardRef< maxon::NimbusRef > > > GetAllNimbusRefs () const
 
Bool IsNodeBased () const
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker () 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)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot ()
 
CTrackGetFirstCTrack ()
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
 
GeListNodeGetPred ()
 
GeListNodeGetDown ()
 
GeListNodeGetUp ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove ()
 
GeListHeadGetListHead ()
 
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)
 
GeListNodeGetCustomData ()
 
BaseDocumentGetDocument ()
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated ()
 
Int32 GetInfo ()
 
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)
 
C4DAtomGetClone (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)
 
DynamicDescriptionGetDynamicDescription ()
 
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)
 

Private Member Functions

 TP_PGroup ()
 
 ~TP_PGroup ()
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (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 ( void  )

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

Returns
The group level.

◆ GetFirstNode()

TP_ParticleNode* GetFirstNode ( void  )

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

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

◆ GetLastNode()

TP_ParticleNode* GetLastNode ( void  )

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

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]groupA group. The caller owns the pointed TP_PGroup.
Returns
true if group is a subgroup of the group, otherwise false.

◆ GetGroupID()

Int32 GetGroupID ( void  )

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

Gets the group title.

Returns
The group title.

◆ SetTitle()

void SetTitle ( const maxon::String title)

Sets the group title.

Parameters
[in]titleThe new group title.

◆ GetViewType()

Int32 GetViewType ( void  )

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]typeThe new view type. See PGROUP_VIEWTYPE in description/tp_group.h.

◆ GetShowObjects()

Bool GetShowObjects ( void  )

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]showThe new show-objects flag.

◆ GetColor()

Vector GetColor ( void  )

Gets the color of the group.

Returns
The group color.

◆ SetColor()

void SetColor ( Vector col)

Sets the color of the group.

Parameters
[in]colThe new group color.

◆ EditSettings()

Bool EditSettings ( void  )

Opens the edit dialog for the group.

Returns
true if the user clicked OK, otherwise false.

◆ IsSelected()

Bool IsSelected ( void  )

Checks if the group is selected in the group list.

Returns
true if the group is selected, otherwise false.

◆ IsOpened()

Bool IsOpened ( void  )

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]modeThe selection mode: SELECTION

◆ Open()

void Open ( Bool  onoff)

Opens or closes the group in the group list.

Parameters
[in]onofftrue 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]useColtrue 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]onofftrue 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.