Imager modo 401 extension: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
m Imager modo401 extension moved to Imager modo 401 extension: Added a space for readability.
Undo revision 7097 by LLutz74 (talk)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{extension
{{extension
  | company = yourcompanyname
  | company = Luxology
  | purpose = short description
  | purpose = Custom camera imager
| 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 = 17 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 camera imager settings 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, with an extended imager described in terms of an aperture size and an offset.<!-- 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>/<imager>
|-
|-
!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
|-
|apertureX||Film_Width||Width of the camera aperture||float||0.036||1||
|-
|apertureY||Film_Height||Height of the camera aperture||float||0.024||1||
|-
|offsetX||Film_Offset_X||Horizontal offset of the camera aperture||float||0||0 or 1||
|-
|offsetY||Film_Offset_Y||Vertical offset of the camera aperture||float||0||0 or 1||
|-
|-
|Example||Specifies foo.||N/A||0 or more
|filmFit||Film_Fit||Method for fitting the aperture||Name||fill||0 or 1||fill, horizontal, vertical, overscan
|}
|}


===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. -->
:If the modo 401 imager extension is present, then at a minimum, the param elements for "apertureX" and "apertureY" must be present.<!-- 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">
            ...
            <imager>
                <technique profile="modo401">
                    <param sid="apertureX" name="Film_Width" type="float">0.036</param>
                    <param sid="apertureY" name="Film_Height" type="float">0.024</param>
                    <param sid="offsetX" name="Film_Offset_X" type="float">0</param>
                    <param sid="offsetY" name="Film_Offset_Y" type="float">0</param>
                    <param sid="filmFit" name="Film_Fit" type="Name">fill</param>
                </technique>
            </imager>
        </camera>
    </library_cameras>

Latest revision as of 18:04, 26 September 2011

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 camera imager settings supported by modo 401.

Concepts

The modo render engine provides a general purpose camera, with an extended imager described in terms of an aperture size and an offset.
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>/<imager>
Extra and/or Technique <extra>/<technique profile="modo401">
Child elements None
Other
Child Elements
sid name Description type Default Occurrences Named values
apertureX Film_Width Width of the camera aperture float 0.036 1
apertureY Film_Height Height of the camera aperture float 0.024 1
offsetX Film_Offset_X Horizontal offset of the camera aperture float 0 0 or 1
offsetY Film_Offset_Y Vertical offset of the camera aperture float 0 0 or 1
filmFit Film_Fit Method for fitting the aperture Name fill 0 or 1 fill, horizontal, vertical, overscan

Details

If the modo 401 imager extension is present, then at a minimum, the param elements for "apertureX" and "apertureY" must be present.

Examples

   <library_cameras>
       <camera id="Camera-Camera" name="Camera">
           ...
           <imager>
               <technique profile="modo401">
                   <param sid="apertureX" name="Film_Width" type="float">0.036</param>
                   <param sid="apertureY" name="Film_Height" type="float">0.024</param>
                   <param sid="offsetX" name="Film_Offset_X" type="float">0</param>
                   <param sid="offsetY" name="Film_Offset_Y" type="float">0</param>
                   <param sid="filmFit" name="Film_Fit" type="Name">fill</param>
               </technique>
           </imager>
       </camera>
   </library_cameras>