TECHNICAL PAPER Building Tools for Houdini 9

More documents

Recommendations

Info

Appendix B: Help Card Format with Wiki MarkupNode Help Structure= Title =#context: obj#internal: tool_name#largeicon: opdef:Object/tool_name?largeicon.png#smallicon: opdef:Object/tool_name?smallicon.png“””Summary”””Introductory/overview text.@usage#. Select the objects.#. Click the shelf item.Houdini creates a new Node Label node at the object level.@parametersParm 1:Explanation.Parm 2:Explanation.Shelf item help structure= Title =#largeicon: opdef:Object/blah?largeicon.png#smallicon: opdef:Object/blah?smallicon.png“””Summary”””Introductory/overview text.@usage#. Select the objects.#. Click the shelf item.28 | TECHNICAL PAPER Rev 1.0
Help components:TitleThis should be the human-readable label of the node or shelf item.SummaryAim for the summary to do two things: summarize the item’s purpose, and ideally give a short bit of instructionon how to use it. You should start with a short, pithy summary of the purpose of the node/shelf item. Start thesentence with a verb in the simple future tense. Don’t start the description with the name of the node, or “Thisnode...” or “This allows you to...” etc.The summary is used as the tooltip for items on the shelf.= Drops =“””Creates an animated rain simulation asset using the selected objects as raindrops.”””@usagePut instructions here about how to use the tool under this heading.@usage#. Create profile curves that define the shape of the surface.#. Click the tool.#. Select the profile curves in order.@parametersFor node documentation, put descriptions of the parameters under this heading.The list of parameters is a definition list: the name of a parameter on a line ending with a colon (:), and thenone or more paragraphs describing the parameter indented under it.Position:Paragraph 1.Paragraph 2.Paragraph 3.Rotation:Paragraph.Building Tools for Houdini 9 | 29
Page 1 and 2: TECHNICAL PAPERBuilding Tools for H
Page 3 and 4: Scripts: HOUDINI_SCRIPT_PATH 23Pyth
Page 5 and 6: 2.What are Tools and how are they u
Page 7 and 8: inside it. If Create in Context is
Page 9 and 10: ▪ ▪ Name is the internal name o
Page 11 and 12: 4.Steps to Develop a ToolIn this se
Page 13 and 14: 5.Designing Tools for Wider Distrib
Page 15 and 16: Parameters Folder3.The Gear Menu al
Page 17: 0003 active_pane = toolutils.active
Page 20 and 21: equivalent Python commands hou.Node
Page 22 and 23: the section Distribution with Expli
Page 24 and 25: to the Houdini on-line help.Distrib
Page 26 and 27: Componentsand lighting will have to
Page 30 and 31: Use heading 3s to represent paramet
Page 32 and 33: Examplehelp URLOBJSOPPOPDOPPOPCOP2t
Page 34 and 35: Components Description:FILE - is th
Page 36 and 37: Appendix E: ReferencesLearning Pyth
Page 38: Side Effects SoftwareProduction Con

TECHNICAL PAPER Building Tools for Houdini 9

Create successful ePaper yourself

Delete template?

Save as template?