User Macro Document - textured_background ####PAGE_TITLE#### coloured_background

<table cellspacing="0" cellpadding="0"> <tr height="150"> <td align="left"><img src="../../../../img/logo.gif" alt="IAC logo"></img></td> <td width="100%" rowspan="2" align="left" valign="center"> <table cellspacing="0" cellpadding="0"> <tr> <td> <table class="navigate_doc" width="100%" border="0" align="center"> <tr bgcolor="c6c6e0" align="center"> <th nowrap width="1%" height="32">P0094</th> <th nowrap width="98%">Background</th> <th nowrap width="1%">30th May 2000</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Sabreen Vig, Larry Gelberg, Ian Curington, AVS Inc.; Andrew Dodd, IAC <b>Version:</b> 1.2 <b>Path:</b> iac_proj/backgrnd/</p> <a href="../../misc.shtml" target="_top"><img src="../../../../img/misc.gif" width="42" height="30" border="0" alt="Miscellaneous"></a> <a href="backgrnd.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - background_generator"></a> <a href="t_c_bg.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - textured_background & coloured_background"></a> <a href="source/misc/backgrnd/backgrnd.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - backgrnd.tar.gz"></a> <a href="source/misc/backgrnd/backgrnd.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - backgrnd.tar.Z"></a> <a href="source/misc/backgrnd/backgrnd.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - backgrnd.zip"></a> <a href="image_bg_fade.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> <a href="image_bg_pic.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>textured_background & coloured_background</h1> <h3>Synopsis</h3> <p>The textured_background and coloured_background macros both create a DataObject that can be used as a static background to a Viewer window. The textured_background macro uses a supplied image field while the coloured_background macro generates a interpolated fade based on 4 RGB values.</p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by textured_background"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>texture_in</i></td> <td width="75">Image</td> <td width="425">Image to use as Viewer background.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by textured_background & coloured_background"> <tr> <td width="150"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="300"><b>Description</b></td> <td width="125"><b>UI Control</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="150"><i>depth</i></td> <td width="50">float</td> <td width="300">Distance background is from camera.</td> <td width="100">None</td> </tr> <tr> <td width="150"> <i>Upper_Left_Red</i><br> <i>Upper_Left_Green</i><br> <i>Upper_Left_Blue</i> </td> <td width="50">float</td> <td width="300">RGB values for upper left corner of image.</td> <td width="100">UIslider</td> </tr> <tr> <td width="150"> <i>Upper_Right_Red</i><br> <i>Upper_Right_Green</i><br> <i>Upper_Right_Blue</i> </td> <td width="50">float</td> <td width="300">RGB values for upper right corner of image.</td> <td width="100">UIslider</td> </tr> <tr> <td width="150"> <i>Lower_Left_Red</i><br> <i>Lower_Left_Green</i><br> <i>Lower_Left_Blue</i> </td> <td width="50">float</td> <td width="300">RGB values for lower left corner of image.</td> <td width="100">UIslider</td> </tr> <tr> <td width="150"> <i>Lower_Right_Red</i><br> <i>Lower_Right_Green</i><br> <i>Lower_Right_Blue</i> </td> <td width="50">float</td> <td width="300">RGB values for lower right corner of image.</td> <td width="100">UIslider</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by textured_background & coloured_background"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>out_fld</i></td> <td width="75">Mesh+Node_Data</td> <td width="425">Field containing Quad cell-set that is used as background.</td> </tr> <tr> <td width="100"><i>out_obj</i></td> <td width="75">GDobject</td> <td width="425">Directly renderable output object.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p>The textured_background and coloured_background macro both create a DataObject that can be used as the background to a Viewer window. The textured_background macro allows an image to be used as the background while the coloured_background macro allows the user to specify a colour fade.</p> <p>The effect of a static viewer window background is produced by creating a field that contains a single square cell-set. This cell-set is sized so that it covers the viewer window and is slightly in front of the far clipping plane. The far clipping plane specifies the maximum distance that an object can be away from the camera before it is ignored. Therefore by placing the background slightly in front of the far clipping plane it should be behind everything else. The field is then placed into a DataObject and the transformation of the DataObject is locked. This ensures that the background is not transformed with the rest of the scene.</p> <p>The background image is created by using node data. The coloured_background macro creates a set of node data with a triplet of RGB values at each corner of the square. AVS/Express interpolates between each of these RGB values as normal to create the colour fade effect that can be seen. In a similarly the textured_background macro creates a set of node data. However this node data specifies texture coordinates for each corner of the square. These texture coordinates are then used to texture map the square with the input image. The input image can be any AVS/Express image field. The output of the <a href="backgrnd.shtml" target="_top">background_generator</a> macro can be used to generate an alternate form of colour fade.</p> <h3>Inputs</h3> <p><b><i>texture_in</i></b></p> <p>2D image field that should be used to texture map the generated mesh data. This input is only present on the textured_background macro.</p> <h3>Parameters</h3> <p><b><i>depth</i></b></p> <p>This floating point parameter specifies now far the background should be from the camera. By default this distance is 0.98 and therefore the background is just in front of the far clipping plane. Normally this distance will not need to be changed and hence no user interface component is presented. However if the far clipping plane is altered or you wish to occlude some parts of your model this parameter can be used.</p> <p> <table class="parameters" summary="RGB Parameters"> <tr> <td width="120"> <b><i>Upper_Left_Red<br> Upper_Left_Green<br> Upper_Left_Blue</i></b></td> <td width="120"> <b><i>Upper_Right_Red<br> Upper_Right_Green<br> Upper_Right_Blue</i></b></td> </tr> <tr> <td width="120"> <b><i>Lower_Left_Red<br> Lower_Left_Green<br> Lower_Left_Blue</i></b></td> <td width="120"> <b><i>Lower_Right_Red<br> Lower_Right_Green<br> Lower_Right_Blue</i></b></td> </tr> </table> </p> <p>The shading of the quad cell-set generated by the coloured_background macro is calculated by blending the colours at the corners towards the centre of the image. The colours of the 4 corners of the image are specified by the parameters shown in the table above. The colours are specified in the Red-Green-Blue colour model. These parameters are only present on in the coloured_background macro.</p> <h3> <b>Outputs</b></h3> <p><b><i>out_fld</i></b></p> <p>Output field containing the generated background field data. This field contains a Quad cell-set and a single set of node data. In the coloured_background macro this node data contains the RGB colour values for each corner while in the textured_background macro this node data contains the texture coordinates for each corner. Normally this output should not be used as its transformation is not locked and it does not contain the necessary texture image.</p> <p><b><i>out_obj</i></b></p> <p>The GDobject version of the output. If this output is connected to a viewer a background will be placed into that viewer window. The output object contains the generated field data and, if necessary, the texture image data. The transformation for the output object is locked so that the background will always stay at the back of the visualization.</p> <h3>Utility Macros</h3> <p>The user macro coloured_background uses the RGB_BackgroundParams parameter block and the RGB_BackgroundUI user interface macro. The textured_background macro does not use either a parameter block or a user interface.</p> <h3>Example</h3> <p>The TexturedBackgroundEg example application uses the <a href="backgrnd.shtml" target="_top">background_generator</a> macro to create a background image and then uses it as the background to the teapot. The ColouredBackgroundEg example application creates a similar colour fade and also uses it as the background to the teapot.</p> <h3>Files</h3> <p><i>iac_proj/backgrnd/bg_mods.v</i> contains the V definitions of the BackgroundCore module and the BackgroundParams and RGB_BackgroundParams parameter blocks.</p> <p><i>iac_proj/backgrnd/bg_macs.v</i> contains the V definitions of the BackgroundUI and RGB_BackgroundUI UI macro, the BackgroundFunc functional macro and the background, textured_background and coloured_background user macros.</p> <p><i>iac_proj/backgrnd/bg_apps.v</i> contains the V definition of the BackgroundEg, TexturedBackgroundEg and ColouredBackgroundEg example applications.</p> <h3>Other Notes</h3> <p>Neither of these user macros rely on low-level code and hence do not need to be compiled. The <a href="backgrnd.shtml" target="_top">background_generator</a> user macro does rely on the low-level BackgroundCore module. If this macro is to be used the project should be compiled as normal.</p> <h3>Authors</h3> <p> <pre> Sabreen Vig, Larry Gelberg, Ian Curington Advanced Visual Systems, Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> Andrew Dodd, International AVS Centre </pre> </p> <h3>Contact</h3> <p> <pre> International AVS Centre Manchester Visualization Centre Manchester Computing University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre> </p> <h3>See Also</h3> <ul> <li><a href="backgrnd.shtml" target="_top">background_generator</a> user macro.</li> </ul>  </td> </tr> </table> </td> </tr> <tr height="100%"> <td class="sideLink" width="25%" align="left" valign="top" nowrap="nowrap"> <p><a href="../../../../general/index.shtml" target="_top">General Information</a></p> <p><a href="../../../../repository/index.shtml" target="_top">Repositories</a></p> <p class="sideLinkLevel2"><a href="../../../new/index.shtml" target="_top">  New Releases</a></p> <p class="sideLinkLevel2"><a href="../../../download/index.shtml" target="_top">  Download</a></p> <p class="sideLinkLevel2"><a href="../../../submit/index.shtml" target="_top">  Submit</a></p> <p class="sideLinkLevel2"><a href="../../../pfiles/index.shtml" target="_top">  Project Files</a></p> <p class="sideLinkLevel2"><a href="../../../avs5/index.shtml" target="_top">  AVS5</a></p> <p class="sideLinkLevel2"><a href="../../../express/index.shtml" target="_top">  AVS/Express</a></p> <p class="sideLinkLevel3"><a href="../../atoz.shtml" target="_top">    A to Z</a></p> <p class="sideLinkLevel3"><a href="../../number.shtml" target="_top">    Project #</a></p> <p></p> <p class="sideLinkLevel3"><a href="../../data_io.shtml" target="_top">    Data IO</a></p> <p class="sideLinkLevel3"><a href="../../filters.shtml" target="_top">    Filters</a></p> <p class="sideLinkLevel3"><a href="../../mappers.shtml" target="_top">    Mappers</a></p> <p class="sideLinkLevel3"><a href="../../misc.shtml" target="_top">    Miscellaneous</a></p> <p class="sideLinkLevel3"><a href="../../special.shtml" target="_top">    Special Projects</a></p> <p class="sideLinkLevel2"><a href="../../../pog/index.shtml" target="_top">  Project Guidelines</a></p> <p><a href="../../../../usergroup/index.shtml" target="_top">User Group</a></p> <p><a href="../../../../training/index.shtml" target="_top">Training Materials</a></p> </td> </tr> </table> <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="c6c6e0"> <tr> <td><img src="../../../../img/foot1.gif" alt="IAC" width="155" height="25"></td> <td width="100%"> Last Updated:  26th November 2002 </td> </tr> </table>