User Documentation

From K-3D

(Difference between revisions)
Jump to: navigation, search
(User Interface)
m (Reverted edits by Robbar (Talk) to last revision by Tshead)
 
(48 intermediate revisions not shown)
Line 1: Line 1:
-
[[K-3D]] > [[User Documentation]]
 
-
----
 
-
 
== Overview ==
== Overview ==
If you haven't installed K-3D yet, please consult [[Getting Started]] for build / install instructions on many platforms.
If you haven't installed K-3D yet, please consult [[Getting Started]] for build / install instructions on many platforms.
-
<b>Note:</b> Not all features are available on all platforms, and some features may be disabled depending on the libraries available on the local host.
+
* [[FAQ]] - User's Frequently Asked Questions!
-
 
+
-
== FAQ ==
+
-
 
+
-
* [[FAQ]] - User's FAQ!
+
* [[Version Numbers]] - What do those numbers mean?
* [[Version Numbers]] - What do those numbers mean?
-
* [[BasicUsage]] - Overview of K-3D's functionalities.
 
* [[:Category:Tutorials|Online Tutorials]] - Step-by-step instructions for common operations.
* [[:Category:Tutorials|Online Tutorials]] - Step-by-step instructions for common operations.
 +
* [[Support]] - Where to go for help when good software goes bad ...
== User Interface ==
== User Interface ==
-
* [[Running K-3D]]
+
* {{New in 0.7}} [[Command Line Options]]
-
* [[The K-3D Window]]
+
* {{New in 0.7}} [[Native Language Support]]
-
* [[Opening_And_Saving_Scenes]]
+
* {{Pre 0.7}} [[Running K-3D]]
-
* [[Working_With_Panels]]
+
* [[Main Document Window]] - K-3D provides a top-level window for each open document.
-
** [[Viewport]]
+
* [[Default Document]]
-
** [[Node List]]
+
* [[Opening And Saving Scenes]]
-
** [[Node History]]
+
* [[Working With Panels]] - Most of the K-3D user interface is broken-down into [[:Category:Panels|Panels]].
-
** [[Node Properties]]
+
* [[Tools]] - Tools are used to modify a document interactively, by clicking-and-dragging the mouse in a viewport.
-
** [[Toolbar]]
+
-
** [[Undo Tree]]
+
-
** [[Directed Graph]]
+
-
* [[Toolbox]]
+
-
** [[Move Tool]]
+
-
** [[Select Tool]]
+
-
** [[RotateTool]]
+
-
** [[ScaleTool]]
+
-
** [[ParentTool]]
+
-
** [[PlugTool]]
+
-
** [[RenderTool]]
+
* [[Hotkeys]]
* [[Hotkeys]]
-
* [[Tutorial Dialog]]
+
* [[Tutorial Menu]]
-
* [[Command Node Inspector]]
+
* [[Script Editor]]
* [[Script Editor]]
-
* [[SimpleWorkFlowExample]]
+
* [[Viewports and Cameras]]
 +
* [[SimpleWorkFlowExample|Simple Work Flow Example]]
 +
* [[User Properties]] - Customize existing K-3D nodes by adding your own user properties!
 +
* [[Recording Tutorials]] - Feeling confident?  You can record tutorials for other users!
 +
 
 +
== External Files ==
 +
 
 +
* [[Import and Export]] - how to work with files from other applications.
 +
* [[Managing External Files]] - details on how external file data is stored.
== Plugins ==
== Plugins ==
-
* See [[:Category:Plugins]] for a list of all K-3D plugins and links to reference documentation.
+
* See [[Plugins]] for a list of all K-3D plugins and links to reference documentation.
* [[Plugin Status]] - What does (Experimental) or (Deprecated) next to a plugin's name mean?
* [[Plugin Status]] - What does (Experimental) or (Deprecated) next to a plugin's name mean?
 +
 +
== Modeling ==
 +
 +
* [[Mug Tutorial]] - creating a mug with a handle.
 +
* [[Snap Tutorial]] - some samples of the new interactive snap system.
 +
* [[Symmetric Modeling Tutorial]] - modeling just one side of a symmetric object, with automatic updates to the mirror side.
 +
 +
== Materials ==
 +
 +
* [[Surface Color Tutorial]] - changing the color of a geometric surface.
== Rendering ==
== Rendering ==
Line 51: Line 50:
* [[Materials]] - Working with surface materials in K-3D.
* [[Materials]] - Working with surface materials in K-3D.
* [[Render Engine]] - An overview of render engines for K-3D.
* [[Render Engine]] - An overview of render engines for K-3D.
 +
* [[RenderMan Options and Attributes]] - How to specify custom RenderMan attributes in a K-3D document.
* [[RenderMan]]
* [[RenderMan]]
** [[RenderMan Controls]] - Tips on how to control the quality of your RenderMan output.
** [[RenderMan Controls]] - Tips on how to control the quality of your RenderMan output.
** [[RenderMan_Shaders|List of Shaders]]
** [[RenderMan_Shaders|List of Shaders]]
-
** [[RenderMan Light Shaders]]
+
** [[RenderManLightShader]]
-
** [[RenderMan Displacement Shaders]]
+
** [[RenderManDisplacementShader]]
** [[RenderMan Shading Language]]
** [[RenderMan Shading Language]]
** [[RenderMan_Surface_Shader|Writing Surface Shaders]]
** [[RenderMan_Surface_Shader|Writing Surface Shaders]]
Line 62: Line 62:
** [[RenderMan_Volume_Shader|Writing Volume Shaders]]
** [[RenderMan_Volume_Shader|Writing Volume Shaders]]
** [[RenderMan_Imager_Shader|Writing Imager Shaders]]
** [[RenderMan_Imager_Shader|Writing Imager Shaders]]
-
** [[FrankenRender|Franken Render]] - Tips for using Aqsis with BMRT as a rayserver.
+
** [[FrankenRender]] - Tips for using Aqsis with BMRT as a rayserver.
** [[Shadow Map Tutorial]]
** [[Shadow Map Tutorial]]
* [[Hardware Rendering]] - Why can't I preview lighting and shading in the viewport?
* [[Hardware Rendering]] - Why can't I preview lighting and shading in the viewport?
-
* [[Network Rendering]] - About network rendering.
 
* [[Texture Tutorial]] - How to texture a scene.
* [[Texture Tutorial]] - How to texture a scene.
* [[Yafray]] - Using the Yafray render engine
* [[Yafray]] - Using the Yafray render engine
-
 
-
== Modeling ==
 
-
 
-
* [[Symmetric Modeling]] - modeling just one side of a symmetric object, with automatic updates to the mirror side.
 
-
* [[Mug Tutorial]] - creating a mug with a handle.
 
== Animation ==
== Animation ==
Line 81: Line 75:
== Scripting ==
== Scripting ==
-
* [[ScriptEngine]] - Introduction to K-3D scripting.
+
* [[Scripting]] - Provides an introduction to K-3D scripting.
-
* [[Python Engine]] - Python documentation.
+
* [[Python]] - Documentation for the Python script engine used for most general-purpose scripting tasks.
 +
* [[K3DScript]] - K-3D tutorials are recorded using K3DScript metafiles.
* [[RenderManScript]] - Injects arbitrary [[RenderMan]] API calls into the rendered scene.
* [[RenderManScript]] - Injects arbitrary [[RenderMan]] API calls into the rendered scene.
Line 90: Line 85:
* [[SDS Tutorial]] - Basic subdivision surface modeling tutorial.
* [[SDS Tutorial]] - Basic subdivision surface modeling tutorial.
* [[SDS Creases]] - Variable sharpness creases on subdivision surface models.
* [[SDS Creases]] - Variable sharpness creases on subdivision surface models.
 +
 +
[[Category:Documentation]]

Current revision as of 14:01, 4 August 2010

Overview

If you haven't installed K-3D yet, please consult Getting Started for build / install instructions on many platforms.

  • FAQ - User's Frequently Asked Questions!
  • Version Numbers - What do those numbers mean?
  • Online Tutorials - Step-by-step instructions for common operations.
  • Support - Where to go for help when good software goes bad ...

User Interface

External Files

Plugins

  • See Plugins for a list of all K-3D plugins and links to reference documentation.
  • Plugin Status - What does (Experimental) or (Deprecated) next to a plugin's name mean?

Modeling

Materials

Rendering

Animation

Scripting

  • Scripting - Provides an introduction to K-3D scripting.
  • Python - Documentation for the Python script engine used for most general-purpose scripting tasks.
  • K3DScript - K-3D tutorials are recorded using K3DScript metafiles.
  • RenderManScript - Injects arbitrary RenderMan API calls into the rendered scene.

Subdivision Surfaces

Personal tools