CreateICENodeCom ment

Introduced

7.0

Description

Creates a comment on the ICENode. An ICE comment is similar to a tooltip in the ICE view. It is basically simple property editor with a text box and some formatting controls that allows you to control its text and appearance (color, resizing, etc.).

Tip: To remove a comment node, use the DeleteObj command.

Scripting Syntax

    CreateICENodeComment( InputObj )

Parameters

Parameter | Type | Description
InputObj | SelectionList or Selection | Node on which we want to create the comment. This type of comment is always attached to a single node, so you cannot have more than one on any given node. Default Value: If no argument is specified, the current selection is used.

Return Value

an Operator of type "ICETreeComment"

Examples

VBScript Example

    '
    ' This example demonstrates how to create, modify and delete
    ' an ICE comment.
    '
    NewScene , false
    CreatePrim "Cone", "MeshSurface"

    ' Create a simple ICE tree with an Add node
    ApplyOp "ICETree", "cone", siNode, , , 0
    AddICENode "AddNode", "cone.polymsh.ICETree"

    ' Add a comment to the Add node and log its class and type
    set l_comment = CreateICENodeComment("cone.polymsh.ICETree.AddNode")
    Application.LogMessage "Class: " & typename(l_comment)
    Application.LogMessage "Type: " & l_comment.Type

    ' You can use the full string path...
    SetValue "cone.polymsh.ICETree.AddNode.ICETreeComment.Text", "Adds the two vectors"

    ' ... or the return value after creating it
    DeleteObj l_comment

    ' Expected results:
    ' INFO : Class: Operator
    ' INFO : Type: ICETreeComment

See Also

DeleteObj | ICENode

Autodesk Softimage v7.5