SculptBrushModifierData Class Reference

abstract

#include <lib_sculptbrush.h>

Inheritance diagram for SculptBrushModifierData:
Inheritance graph
[ legend ]

详细描述

Data class to create sculpt brush modifier plugins. Use RegisterBrushModifier() to register one.

公共成员函数

virtual Bool   IsDocumentRelated (const GeListNode *node, Bool &docrelated) const
virtual Bool   ApplyModifier ( BrushDabData *dab, const BaseContainer &modifierData)=0
-  Public Member Functions inherited from NodeData
  NodeData ()
GeListNode Get (void) const
virtual Bool   消息 ( GeListNode *node, Int32 type, void *data)
virtual void  GetBubbleHelp ( GeListNode *node, maxon::String &str)
virtual BaseDocument GetDocument ( GeListNode *node)
virtual Int32   GetBranchInfo ( GeListNode *node, BranchInfo *info, Int32 max, GETBRANCHINFO flags)
virtual Bool   IsInstanceOf (const GeListNode *node, Int32 type) const
virtual Bool   Init ( GeListNode *node)
virtual void  Free ( GeListNode *node)
virtual Bool   读取 ( GeListNode *node, HyperFile *hf, Int32 level)
virtual Bool   Write ( GeListNode *node, HyperFile *hf)
virtual Bool   CopyTo ( NodeData *dest, GeListNode *snode, GeListNode *dnode, COPYFLAGS flags, AliasTrans *trn)
virtual Bool   GetDDescription ( GeListNode *node, 描述 *description, DESCFLAGS_DESC &flags)
virtual Bool   GetDParameter ( GeListNode *node, const DescID &id, GeData &t_data, DESCFLAGS_GET &flags)
virtual Bool   SetDParameter ( GeListNode *node, const DescID &id, const GeData &t_data, DESCFLAGS_SET &flags)
virtual Bool   GetDEnabling ( GeListNode *node, const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
virtual Bool   TranslateDescID ( GeListNode *node, const DescID &id, DescID &res_id, C4DAtom *&res_at)
-  Public Member Functions inherited from BaseData
  BaseData ()
virtual  ~BaseData (void)
void  Destructor (void)

Additional Inherited Members

-  Protected Attributes inherited from NodeData
GeListNode private_link

成员函数文档编制

◆  IsDocumentRelated()

virtual Bool IsDocumentRelated ( const GeListNode node ,
Bool docrelated  
) const
virtual

Checks if the node is part of a document or not.

警告
Do not change the implementation of this method!
参数
[in] node The modifier node to check.
[out] docrelated Set to true if the node is part of a document.
Modifiers are not part of the document so this is always set to false .
返回
true if successful, otherwise false .

Reimplemented from NodeData .

◆  ApplyModifier()

virtual Bool ApplyModifier ( BrushDabData dab ,
const BaseContainer modifierData  
)
pure virtual

Applies the effect of the modifier to the dab.

参数
[in] dab The brush dab data.
[in] modifierData The container of the modifier data.
返回
true if successful, otherwise false .