Open Search
    c4d_basechannel.h File Reference

    Classes

    class  BaseShader
     
    class  BaseChannel
     

    Functions

    Bool HandleShaderPopupI (BaseList2D *parent, BaseShader *&current, Int32 value, Int param)
     
    Bool BuildShaderPopupMenuI (BaseContainer *menu, BaseList2D *parent, BaseShader *current, Int param)
     
    Bool HandleShaderPopup (const BaseContainer &bc, const DescID &descid, Int32 value, Int param)
     
    Bool BuildShaderPopupMenu (BaseContainer *menu, const BaseContainer &bc, const DescID &descid, Int param)
     
    String GetChannelName (Int32 channelid)
     

    Function Documentation

    ◆ HandleShaderPopupI()

    Bool HandleShaderPopupI ( BaseList2D parent,
    BaseShader *&  current,
    Int32  value,
    Int  param 
    )

    Simplifies the task of shader operations: undo handling, removing existing shaders, keeping track of the shader trees etc. ('I' stands for isolated.)

    See also
    HandleShaderPopup()
    Parameters
    [in]parentElement that carries the shaders. The caller owns the pointed object.
    [in]currentCurrently set element, might be deleted, in which case the pointer is set to nullptr. The caller owns the pointed shader.
    [in]valueThe operation: SHADERPOPUP
    [in]paramThe parameter. Depends on value
    Returns
    true if successful, otherwise false.

    ◆ BuildShaderPopupMenuI()

    Bool BuildShaderPopupMenuI ( BaseContainer menu,
    BaseList2D parent,
    BaseShader current,
    Int  param 
    )

    Private.

    ◆ HandleShaderPopup()

    Bool HandleShaderPopup ( const BaseContainer bc,
    const DescID descid,
    Int32  value,
    Int  param 
    )

    Simplifies the task of shader operations: undo handling, removing existing shaders, keeping track of the shader trees etc.

    See also
    HandleShaderPopupI().
    Parameters
    [in]bcA container with links to BaseList2D elements. These must be stored under increasing IDs (starting with 1).
    [in]descidThe description ID under which the shaders are stored.
    [in]valueThe operation: SHADERPOPUP
    [in]paramThe parameter. Depends on value
    Returns
    true if successful, otherwise false.

    ◆ BuildShaderPopupMenu()

    Bool BuildShaderPopupMenu ( BaseContainer menu,
    const BaseContainer bc,
    const DescID descid,
    Int  param 
    )

    Private.

    ◆ GetChannelName()

    String GetChannelName ( Int32  channelid)

    Retrieves the name for the given channel type ID.

    Parameters
    [in]channelidThe channel type: CHANNEL
    Returns
    The name for the channel type.