Optics modo 401 extension: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
← Older edit
m Optics modo401 extension moved to Optics modo 401 extension: Added a space for readability.
m date
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{extension
{{extension
  | company = yourcompanyname
  | company = Luxology
  | purpose = short description
  | purpose = Custom camera optics
| company = ...
  | product = modo 401
  | product = product this applies to (match name of wiki page for this product)
  | product2 =
  | product2 = 2nd product or blank
  | product3 =
  | product3 = 3rd product or blank
  | contact_email = customer_service@luxology.com
  | contact_email = ...
  | last_updated = 21 Aug 09}}
  | last_updated = ...}}


==<your_element> Element==
==<extra>/<technique profile="modo401">/<param> Elements==
<!--   
<!--   
           TIP: The ":" at the beginning of lines indents them.  
           TIP: The ":" at the beginning of lines indents them.  
-->
-->
:'''Category:''' <!-- fill in  --> (See [[list of specification categories]])
:'''Category:''' '''(core)''' Camera <!-- fill in  --> (See [[list of specification categories]])


:'''Introduction:''' <!-- fill in one sentence starting with a verb that describes purpose of this element -->
:'''Introduction:''' Describes custom cameras, include the specialized spherical camera sub-type supported by modo 401.<!-- fill in one sentence starting with a verb that describes purpose of this element -->


===Concepts===
===Concepts===
:<!-- Background info needed to understand this element's purpose and place within COLLADA -->
:The modo render engine provides a general purpose camera, including perspective and orthographic optics as specified by the common COLLADA technique, as well as a specialized spherical camera.<!-- Background info needed to understand this element's purpose and place within COLLADA -->


:{| {{prettytable}}
:{| {{prettytable}}
Line 24: Line 23:
!Name||Type||Description||Required?
!Name||Type||Description||Required?
|-
|-
|example||xs:token||A text string value that specifies blah.||Yes
|sid||xs:ncname||A unique symbol within the technique; one for each param.||Yes
|-
|name||xs:ncname||A user-friendly name for the param.||no
|}
|}


Line 30: Line 31:
|+ '''Related Elements'''
|+ '''Related Elements'''
!Parent element(s)
!Parent element(s)
| list_here
| <camera>/<optics>
|-
|-
!Extra and/or Technique
!Extra and/or Technique
| fill_in <!-- e.g., <extra type="foo">/<technique profile="BAR"> -->
| <extra>/<technique profile="modo401"><!-- e.g., <extra type="foo">/<technique profile="BAR"> -->
|-
|-
!Child elements
!Child elements
| list_here <!--  or state None -->
| None<!--  or state None -->
|-
|-
!Other
!Other
| list_here <!-- list any other relevant elements -->
| <!-- list any other relevant elements -->
|}
|}


:{| {{prettytable}}
:{| {{prettytable}}
|+ '''Child Elements'''
|+ '''Child Elements'''
!Name||Description||Default||Occurrences
!sid||name||Description||type||Default||Occurrences||Named values
|-
|targetID||Target_Node_ID||ID of the item targeted by this camera||Name|| ||0 or 1||
|-
|targetEnable||Target_Enable||If targeting is enabled||bool||false||0 or 1||
|-
|targetFocus||Target_Focus||If camera focus is linked to target distance||bool||false||0 or 1||
|-
|target||Target_Distance||Distance at which camera should focus on target||float||5.0||0 or 1||
|-
|targetRoll||Target_Roll||Angular offset from target along look axis||float||0||0 or 1||
|-
|projType||Projection_Type||Optical projection type||Name||persp||1||persp, ortho, spherical
|-
|focalLen||Focal_Length||Distance from center of lens to focal point||float||0.05||1||
|-
|distort||Lens_Distortion||Amount of lens distortion||float||0||0 or 1||
|-
|squeeze||Lens_Squeeze||Horizontal lens squeeze||float||1.0||0 or 1||
|-
|focusDist||Focus_Distance||Distance at which image is in focus||float||4||0 or 1||
|-
|fStop||F-Stop||Focal length divided by effective aperture diameter||float||4||0 or 1||
|-
|blurLen||Blur_Length||Length of blur||float||0.5||0 or 1||
|-
|blurOff||Blur_Offset||Offset of blur||float||0||0 or 1||
|-
|ioDist||Interocular_Distance||Distance between stereo imagers||float||0.065||0 or 1||
|-
|-
|Example||Specifies foo.||N/A||0 or more
|convDist||Convergence_Distance||Distance at which stereo imagers converge||float||1||0 or 1||
|}
|}


===Details===
===Details===
:<!-- Additional info about how and where to use the element (and its children), lists of additional relevant links, detailed value tables for element or attribute values, etc. -->
:The target-related params should only appear if the initial targetID param is present, as those channels are only available for cameras which have a target set. The target-related channels are added during scene load only when a targetID is found.<!-- Additional info about how and where to use the element (and its children), lists of additional relevant links, detailed value tables for element or attribute values, etc. -->


===Examples===
===Examples===
<!-- Really required. -->
<!-- Really required. -->
    <library_cameras>
        <camera id="Camera-Camera" name="Camera">
            <optics>
                <technique_common>
                    <perspective>
                        <xfov sid="HFOV">39.5978</xfov>
                        <yfov sid="YFOV">26.9915</yfov>
                        <znear sid="near_clip">0.01</znear>
                        <zfar sid="far_clip">10000</zfar>
                    </perspective>
                </technique_common>
                <technique profile="modo401">
                    <param sid="targetID" name="Target_Node_ID" type="Name">Geometry-MeshNode</param>
                    <param sid="targetEnable" name="Target_Enable" type="bool">true</param>
                    <param sid="targetFocus" name="Target_Focus" type="bool">true</param>
                    <param sid="target" name="Target_Distance" type="float">5</param>
                    <param sid="targetRoll" name="Target_Roll" type="float">1</param>
                    <param sid="projType" name="Projection_Type" type="Name">persp</param>
                    <param sid="focalLen" name="Focal_Length" type="float">0.05</param>
                    <param sid="distort" name="Lens_Distortion" type="float">0</param>
                    <param sid="squeeze" name="Lens_Squeeze" type="float">1</param>
                    <param sid="focusDist" name="Focus_Distance" type="float">4</param>
                    <param sid="fStop" name="F-Stop" type="float">4</param>
                    <param sid="blurLen" name="Blur_Length" type="float">0.5</param>
                    <param sid="blurOff" name="Blur_Offset" type="float">0</param>
                    <param sid="ioDist" name="Interocular_Distance" type="float">0.065</param>
                    <param sid="convDist" name="Convergence_Distance" type="float">1</param>
                </technique>
            </optics>
        </camera>
    </library_cameras>

Latest revision as of 22:00, 21 August 2009

Extension information
This article is part of the COLLADA extensions directory
Adding to the extensions directory

<extra>/<technique profile="modo401">/<param> Elements

Category: (core) Camera (See list of specification categories)
Introduction: Describes custom cameras, include the specialized spherical camera sub-type supported by modo 401.

Concepts

The modo render engine provides a general purpose camera, including perspective and orthographic optics as specified by the common COLLADA technique, as well as a specialized spherical camera.
Attributes
Name Type Description Required?
sid xs:ncname A unique symbol within the technique; one for each param. Yes
name xs:ncname A user-friendly name for the param. no
Related Elements
Parent element(s) <camera>/<optics>
Extra and/or Technique <extra>/<technique profile="modo401">
Child elements None
Other
Child Elements
sid name Description type Default Occurrences Named values
targetID Target_Node_ID ID of the item targeted by this camera Name 0 or 1
targetEnable Target_Enable If targeting is enabled bool false 0 or 1
targetFocus Target_Focus If camera focus is linked to target distance bool false 0 or 1
target Target_Distance Distance at which camera should focus on target float 5.0 0 or 1
targetRoll Target_Roll Angular offset from target along look axis float 0 0 or 1
projType Projection_Type Optical projection type Name persp 1 persp, ortho, spherical
focalLen Focal_Length Distance from center of lens to focal point float 0.05 1
distort Lens_Distortion Amount of lens distortion float 0 0 or 1
squeeze Lens_Squeeze Horizontal lens squeeze float 1.0 0 or 1
focusDist Focus_Distance Distance at which image is in focus float 4 0 or 1
fStop F-Stop Focal length divided by effective aperture diameter float 4 0 or 1
blurLen Blur_Length Length of blur float 0.5 0 or 1
blurOff Blur_Offset Offset of blur float 0 0 or 1
ioDist Interocular_Distance Distance between stereo imagers float 0.065 0 or 1
convDist Convergence_Distance Distance at which stereo imagers converge float 1 0 or 1

Details

The target-related params should only appear if the initial targetID param is present, as those channels are only available for cameras which have a target set. The target-related channels are added during scene load only when a targetID is found.

Examples

   <library_cameras>
       <camera id="Camera-Camera" name="Camera">
           <optics>
               <technique_common>
                   <perspective>
                       <xfov sid="HFOV">39.5978</xfov>
                       <yfov sid="YFOV">26.9915</yfov>
                       <znear sid="near_clip">0.01</znear>
                       <zfar sid="far_clip">10000</zfar>
                   </perspective>
               </technique_common>
               <technique profile="modo401">
                   <param sid="targetID" name="Target_Node_ID" type="Name">Geometry-MeshNode</param>
                   <param sid="targetEnable" name="Target_Enable" type="bool">true</param>
                   <param sid="targetFocus" name="Target_Focus" type="bool">true</param>
                   <param sid="target" name="Target_Distance" type="float">5</param>
                   <param sid="targetRoll" name="Target_Roll" type="float">1</param>
                   <param sid="projType" name="Projection_Type" type="Name">persp</param>
                   <param sid="focalLen" name="Focal_Length" type="float">0.05</param>
                   <param sid="distort" name="Lens_Distortion" type="float">0</param>
                   <param sid="squeeze" name="Lens_Squeeze" type="float">1</param>
                   <param sid="focusDist" name="Focus_Distance" type="float">4</param>
                   <param sid="fStop" name="F-Stop" type="float">4</param>
                   <param sid="blurLen" name="Blur_Length" type="float">0.5</param>
                   <param sid="blurOff" name="Blur_Offset" type="float">0</param>
                   <param sid="ioDist" name="Interocular_Distance" type="float">0.065</param>
                   <param sid="convDist" name="Convergence_Distance" type="float">1</param>
               </technique>
           </optics>
       </camera>
   </library_cameras>
Retrieved from "https://wikis.khronos.org/collada/index.php?title=Optics_modo_401_extension&oldid=6592"