Open Search
    Public Member Functions | List of all members
    SculptBrushModifierData Class Referenceabstract
    Sculpting | Library » Sculpt Brush

    #include <lib_sculptbrush.h>

    Inheritance diagram for SculptBrushModifierData:
    Inheritance graph
    [legend]

    Detailed Description

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

    Public Member Functions

    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 ()
     
    const GeListNode * Get () const
     
    virtual Bool Message (GeListNode *node, Int32 type, void *data)
     
    virtual void GetBubbleHelp (GeListNode *node, maxon::String &str)
     
    virtual const BaseDocument * GetDocument (const GeListNode *node) const
     
    virtual maxon::Result< Bool > GetBranchInfo (const GeListNode *node, const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const
     
    virtual Bool IsInstanceOf (const GeListNode *node, Int32 type) const
     
    virtual maxon::Result< Bool > GetAccessedObjects (const BaseList2D *node, METHOD_ID method, AccessedObjectsCallback &access) const
     
    virtual maxon::Result< maxon::GenericData > GroupChanges (BaseList2D *node)
     
    virtual Bool Init (GeListNode *node, Bool isCloneInit)
     
    virtual void Free (GeListNode *node)
     
    virtual Bool Read (GeListNode *node, HyperFile *hf, Int32 level)
     
    virtual Bool Write (const GeListNode *node, HyperFile *hf) const
     
    virtual Bool CopyTo (NodeData *dest, const GeListNode *snode, GeListNode *dnode, COPYFLAGS flags, AliasTrans *trn) const
     
    virtual Bool GetDDescription (const GeListNode *node, Description *description, DESCFLAGS_DESC &flags) const
     
    virtual Bool GetDParameter (const GeListNode *node, const DescID &id, GeData &t_data, DESCFLAGS_GET &flags) const
     
    virtual Bool SetDParameter (GeListNode *node, const DescID &id, const GeData &t_data, DESCFLAGS_SET &flags)
     
    virtual Bool GetDEnabling (const GeListNode *node, const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const
     
    virtual Bool TranslateDescID (GeListNode *node, const DescID &id, DescID &res_id, C4DAtom *&res_at)
     
    - Public Member Functions inherited from BaseData
    virtual ~BaseData ()
     
    void Destructor ()
     

    Additional Inherited Members

    - Protected Attributes inherited from NodeData
    GeListNode * private_link
     

    Member Function Documentation

    ◆ IsDocumentRelated()

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

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

    Warning
    Do not change the implementation of this method!
    Parameters
    [in]nodeThe modifier node to check.
    [out]docrelatedSet to true if the node is part of a document.
    Modifiers are not part of the document so this is always set to false.
    Returns
    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.

    Parameters
    [in]dabThe brush dab data.
    [in]modifierDataThe container of the modifier data.
    Returns
    true if successful, otherwise false.