Open Search
    NodeSystemDataInterface Class Reference

    #include <nodesystem_data.h>

    Inheritance diagram for NodeSystemDataInterface:

    Detailed Description

    NodeSystemData represents the serializable data of a NodeSystem. Node systems themselves can't be serialized, however you can call NodeSystem::GetNodeSystemData() to extract their persistent, serializable data and serialize that. After deserialization you have to call Instantiate to obtain a node system from the pure data.

    Public Member Functions

    MAXON_METHOD Result< NodeSystemInstantiate (const NodeSystemClass &cls, const AssetRepositoryRef &repo, Bool *updateReferences) const
     
    MAXON_METHOD SerializationNodeDataGetData ()
     
    MAXON_METHOD Result< NodeSystemInstantiate (const NodeSystemClass &cls, const AssetRepositoryRef &repo, const DataDictionary &additionalContext, Bool *updateReferences) const
     

    Private Member Functions

     MAXON_INTERFACE (NodeSystemDataInterface, MAXON_REFERENCE_COPY_ON_WRITE, "net.maxon.node.interface.nodesystemdata", MAXON_IMPLEMENTATION_MODULE("net.maxon.nodes"))
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( NodeSystemDataInterface  ,
    MAXON_REFERENCE_COPY_ON_WRITE  ,
    "net.maxon.node.interface.nodesystemdata"  ,
    MAXON_IMPLEMENTATION_MODULE("net.maxon.nodes")   
    )
    private

    ◆ Instantiate() [1/2]

    MAXON_METHOD Result<NodeSystem> Instantiate ( const NodeSystemClass &  cls,
    const AssetRepositoryRef &  repo,
    Bool updateReferences 
    ) const

    Instantiates the node system described by this NodeSystemData for the given node system class. To resolve asset references #repo will be used.

    Parameters
    [in]clsThe node system class to use for the instantiation.
    [in]repoThe asset repository to use for asset resolution.
    [out]updateReferencesIf nullptr, asset references won't be updated to the latest version. Otherwise they will (where the ASSET_UPDATE_POLICY allows), and the Bool will be set to true if at least one asset reference was updated.
    Returns
    The node system which is described by this NodeSystemData.

    ◆ GetData()

    ◆ Instantiate() [2/2]

    MAXON_METHOD Result<NodeSystem> Instantiate ( const NodeSystemClass &  cls,
    const AssetRepositoryRef &  repo,
    const DataDictionary &  additionalContext,
    Bool updateReferences 
    ) const

    Instantiates the node system described by this NodeSystemData for the given node system class. To resolve asset references #repo will be used.

    Parameters
    [in]clsThe node system class to use for the instantiation.
    [in]repoThe asset repository to use for asset resolution.
    [in]additionalContextSupplementary instantiation context parameters.
    [out]updateReferencesIf nullptr, asset references won't be updated to the latest version. Otherwise they will (where the ASSET_UPDATE_POLICY allows), and the Bool will be set to true if at least one asset reference was updated.
    Returns
    The node system which is described by this NodeSystemData.