Open Search
    Public Member Functions | List of all members
    SceneSaverData Class Referenceabstract

    #include <c4d_filterdata.h>

    Inheritance diagram for SceneSaverData:
    Inheritance graph
    [legend]

    Detailed Description

    A data class for creating scene saver plugins.
    Use RegisterSceneSaverPlugin() to register a scene saver plugin.

    Public Member Functions

    virtual FILEERROR Save (BaseSceneSaver *node, const Filename &name, BaseDocument *doc, SCENEFILTER filterflags)=0
     
    - Public Member Functions inherited from NodeData
     NodeData ()
     
    GeListNode * Get () const
     
    virtual Bool Message (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 IsDocumentRelated (const GeListNode *node, Bool &docrelated) const
     
    virtual Bool Init (GeListNode *node)
     
    virtual void Free (GeListNode *node)
     
    virtual Bool Read (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 *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 Destructor ()
     

    Additional Inherited Members

    - Protected Attributes inherited from NodeData
    GeListNode * private_link
     

    Member Function Documentation

    ◆ Save()

    virtual FILEERROR Save ( BaseSceneSaver *  node,
    const Filename &  name,
    BaseDocument *  doc,
    SCENEFILTER  filterflags 
    )
    		pure virtual

    Called to save a document.

    Note
    Calling doc->GetDocumentPath() from a scene saver invoked by SaveDocument() is now consistent with the GUI behavior of the export.
    doc->GetDocumentPath() now always returns the current path of the document instead of the target path of the file to save for all formats (except Cinema 4D (*.c4d) and Cinema 4D XML (*.xml)).
    A new document data DOCUMENT_SAVEDOC_DESTINATIONPATH (only set when saving) can be accessed in scene savers to get the destination path of the exported file.
    Parameters
    [in]nodeEqual to static_cast<*>->Get(). Provided for speed and convenience. Cinema 4D owns the pointed node. name The name of the file. doc The document to save the scene from. Cinema 4D owns the pointed document. filterflags The scene filter flags: SCENEFILTER The result of saving the file: FILEERROR