PovClipse tutorial part 2: using the PovClipse editor

The PovClipse editor supports a number of features, which will be shown below.

  • PovClipse perspective: make sure you activate the PovClipse perspective by selecting from the main menu Window => Oper Perspective => Other and select "PovClipse" from the list.
    Eclipse will layout it's screen in the following manner:
    PovClipse Perspective
    All needed views are shown:

    • Navigation tree and Image view on the left
    • Editors in the center
    • Outline view on the right
    • Render Messages, Render Jobs and Problem view on the bottom

  • Code folding: Use the "Fold" icon Unfolded to "fold away" the part of the scene file:
    Code folded

    The "Unfold" icon Folded expands the hidden code section again:
    Code unfolded

  • Code Assistant: Pressing CTRL + SHIFT brings up the code assistant:
    Code assist

    Use the arrow keys "Up" and "Down" to select the keyword you want to use. The list contains all known Povray (Version 3.6) keywords.

    If there are characters left to the actual cursor position, these characters are taken into account to shrink the keyword list. Only those keywords beginning with the characters left to the cursor will be shown:
    Code assist

    In this example we have the characters 'de' just right to the cursor, so the code assistant list contains only keywords beginning with 'de'.

  • Outline: The code outline view shows the scene file's content in an outline manner:
    Outline

    All objects, cameras, light sources, declarations, includes, global constants and so on are listed.

    Selecting an entry in the outline lets the PovClipse editor jump to the corresponding code section. In the screenshot above was the "Declaration: Povray_Logo" entry selected, thus the PovClipse editor automatically brings it up.

    Please note the buttons at the top. They offer the functionallity of sorting the tree, expanding or collapsing the full tree at once and filtering the tree's content.

  • Color editor: Put the cursor somewhere on a valid rgb[f|t|ft] <...> statement and press Ctrl+Shift+C. The Direct color editor opens and displays the color you placed the cursor on:
    Direct color editor

    Play around with the color setting, click on the colored field to select a new color and confirm the dialog using the "OK<" button. Notice how the color statement has changed reflecting your color settings within the dialog.

  • Color map editor: Put the cursor somewhere on a valid color_map statement and press Ctrl+Shift+M. The Color map editor opens and displays the color_map statement you placed the cursor on:
    Color map editor

    Play around with the color_map settings, slide the entries using the blue arrows left of the position value, click on the position value or color text to edit the position and/or the color, use the popup menu to add and remove entries. Confirm the dialog using the "OK" button. Notice how the color_map statement has changed, reflecting what you have set up within the dialog.

  • Brace highlighting: Put the cursor just behind an opening "{" or closing "}" brace. The brace and it's matching counterpart will be highlighted:
    Brace matching

  • Word highlighting: Double-click on a word, let's use sphere. Notice of all occurrences of the word "sphere" are highlighted:
    Word highlighting

  • Hovering: The PovClipse editor gives you information on various things using the Eclipse hover mechanism. Move the mouse pointer over the name of an included file and hold is still for half a second. An information hover appears listing all macros and declarations (objects and variables) introduced by this import:
    Include hover
    Lines being printed in a lighter color and being marked with an asterisk are introduced by an import within the hovered import file.

    The following things support hover information:

    • Imports: The imported macros and declarations
    • Macro names: The interface and comment for the macro
    • Declared variables: the comment on the declared variable
    • rgb[f|t|ft] color statement: visual representation of the color including filter and transmit parts
    • color_map statement: visual representation of the color_map
    • 'Folded' icon Folded icon: The folded code section
    Please check the PovClipse help section on hover support for more information on this topic.

  • Povray and MegaPOV documentation reference: This feature is only available if you have installed the optional PovClipse part "PovrayDocs 3.6 Feature" or "MegaPovDocs 1.2.1 Feature"!
    Put the cursor on a word being a Povray keyword (e.g. camera, box, rgbft ...) and hit Shift+F2.
    If there is only a single reference to the Povray documentation the Eclipse help system pops up showing the corresponding help section (here for the rgbft example):
    Povray help on keyword 'rgbft'
    If there are more than one references a dialog box shows up allowing to select a particular reference (here for the box example):
    Reference selection

  • Hyperlinks: Hold the Ctrl key down and move the mouse over the call to a macro:
    Activated hyperlink
    Notice that the macro name is displayed in a blue color with underline, indicating a hyperlink sensitive are. Click on it to jump to the macro declaration.

    The following are hypertext sensitive areas:

    • Name of a #include file: the included file is opened in an editor (if it is already opened the editor is file activated).
    • Macro names: wherever a macro is used the hyperlink jumps to its definition.
    • Declared variables and objects: wherever a declared variable or object is used the hyperlink jumps to the very first declaration.

    Please check the documentation on hyperlinks for more information.


Hosted by SourceForge.net Logo