Open Search
    NodeSpaceHelpersInterface Class Reference

    #include <node_spaces.h>

    Detailed Description

    NodeSpaceHelpersInterface provides a collection of static helpers.

    Static Public Member Functions

    static MAXON_METHOD DataDictionary GetNodeSpaceData (const Id &spaceId)
     
    static MAXON_METHOD Result< DataDictionary > LoadDescription (const Id &spaceDescriptionId)
     

    Private Member Functions

     MAXON_INTERFACE_NONVIRTUAL (NodeSpaceHelpersInterface, MAXON_REFERENCE_STATIC, "net.maxon.nodes.interface.nodespacehelpers")
     

    Member Function Documentation

    ◆ MAXON_INTERFACE_NONVIRTUAL()

    MAXON_INTERFACE_NONVIRTUAL ( NodeSpaceHelpersInterface  ,
    MAXON_REFERENCE_STATIC  ,
    "net.maxon.nodes.interface.nodespacehelpers"   
    )
    private

    ◆ GetNodeSpaceData()

    static MAXON_METHOD DataDictionary GetNodeSpaceData ( const Id spaceId)
    static

    Looks up the NodeSpaceRef within the MaterialNodeSpaces registry and returns the result of NodeSpaceInterface::GetData().

    Parameters
    [in]spaceIdThe id of the space.
    Returns
    The data container of the space.

    ◆ LoadDescription()

    static MAXON_METHOD Result<DataDictionary> LoadDescription ( const Id spaceDescriptionId)
    static

    Loads resource name under the current language for the provided Id and assigns it to the attribute maxon::nodes::NODESPACE::SPACENAME of the returned data container.

    Parameters
    [in]spaceDescriptionIdThe id of the named description.
    Returns
    The data container with the assigned maxon::nodes::NODESPACE::SPACENAME attribute.