Open Search
    Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
    CustomNodeGuiProxyInterface Class Reference

    #include <customnodeguiproxy.h>

    Public Member Functions

    MAXON_METHOD Result< void > GetReplacementIds (BaseArray< DescID > &replacementIds) const
     
    MAXON_METHOD Result< AttributeManagerProxyRef > GetAttributeManager (GeDialog &dialog) const
     
    MAXON_METHOD Int32 Message (iBaseCustomGui &gui, const BaseContainer &msg, BaseContainer &result)
     

    Static Public Member Functions

    static MAXON_METHOD CustomNodeGuiProxyRef Create (const BaseContainer &settings)
     

    Private Member Functions

     MAXON_INTERFACE_NONVIRTUAL (CustomNodeGuiProxyInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.customnodeguiproxy")
     

    Member Function Documentation

    ◆ MAXON_INTERFACE_NONVIRTUAL()

    MAXON_INTERFACE_NONVIRTUAL ( CustomNodeGuiProxyInterface  ,
    MAXON_REFERENCE_NORMAL  ,
    "net.maxon.interface.customnodeguiproxy"   
    )
    		private

    ◆ Create()

    static MAXON_METHOD CustomNodeGuiProxyRef Create ( const BaseContainer &  settings)
    		static

    Creates the proxy to gain access to node-based elements in the attribute manager.

    Parameters
    [in]settingsThe settings container.
    Returns
    The reference to the proxy, can be nullptr on error.

    ◆ GetReplacementIds()

    MAXON_METHOD Result<void> GetReplacementIds ( BaseArray< DescID > &  replacementIds) const

    Returns the DescIDs of all currently existing elements in the attribute manager that are associated with this gui proxy.

    Parameters
    [out]replacementIdsThe container for the DescID collection.
    Returns
    OK on success.

    ◆ GetAttributeManager()

    MAXON_METHOD Result<AttributeManagerProxyRef> GetAttributeManager ( GeDialog &  dialog) const

    Returns the attribute manager proxy which gives access to node-based attribute handling.

    Parameters
    [in]dialogThe dialog to handle attributes for.
    Returns
    The attribute manager proxy.

    ◆ Message()

    MAXON_METHOD Int32 Message ( iBaseCustomGui &  gui,
    const BaseContainer &  msg,
    BaseContainer &  result 
    )

    Call to forward messages that need to be received received by gui elements that are created through the AttributeManagerProxyRef.

    Parameters
    [in]guiThe gui that should receive messages that have not been consumed by the attribute manager proxy.
    [in]msgThe readable message container.
    [out]resultThe writable message result container.
    Returns
    The message receive status.