Difference between revisions of "Light modo 401 extension"

From COLLADA Public Wiki
Jump to navigation Jump to search
m (Light modo401 extension moved to Light modo 401 extension: Added a space for readability.)
(Light extension info box, details, and example.)
Line 1: Line 1:
 
{{extension
 
{{extension
  | company = yourcompanyname
+
  | company = Luxology
  | purpose = short description
+
  | purpose = Custom light settings
| 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_support@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)''' Lighting <!-- 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 light settings, including various light sub-types 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 collection of light settings and light sub-types, including both the basic directional, point, and spot lights specified by the common COLLADA technique, as well as more specialized light sub-types such as area lights and physically correct sunlights.<!-- 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
 
|}
 
|}
  
Line 30: Line 29:
 
|+ '''Related Elements'''
 
|+ '''Related Elements'''
 
!Parent element(s)
 
!Parent element(s)
| list_here
+
| <visual_scene>
 
|-
 
|-
 
!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
+
!Name||Description||type||Default||Occurrences||Named values
 
|-
 
|-
|Example||Specifies foo.||N/A||0 or more
+
|param sid="lightType"||Name||The sub-type of the light.||N/A||1||See Details
 +
|-
 +
|..||..||..||..||..||..
 
|}
 
|}
  
Line 54: Line 55:
 
===Examples===
 
===Examples===
 
<!-- Really required. -->
 
<!-- Really required. -->
 +
    <library_lights>
 +
        <light id="Light-Directional_Light" name="Directional_Light">
 +
            <technique_common>
 +
                <directional>
 +
                    <color sid="directional_light_rgb">1 1 1</color>
 +
                </directional>
 +
            </technique_common>
 +
            <extra>
 +
                <technique profile="modo401">
 +
                    <param sid="lightType" name="Light_Type" type="Name">sun_light</param>
 +
                    <param sid="azimuth" name="Azimuth" type="float">0</param>
 +
                    <param sid="clamp" name="Clamp_Intensity" type="bool">true</param>
 +
                    <param sid="day" name="Day" type="int">2009172</param>
 +
                    <param sid="elevation" name="Elevation" type="float">0</param>
 +
                    <param sid="haze" name="Haze" type="float">2</param>
 +
                    <param sid="height" name="Height" type="float">10</param>
 +
                    <param sid="lat" name="Latitude" type="float">0.655057</param>
 +
                    <param sid="lon" name="Longitude" type="float">-2.13456</param>
 +
                    <param sid="mapSize" name="Map_Size" type="float">2</param>
 +
                    <param sid="north" name="North" type="float">0</param>
 +
                    <param sid="radius" name="Radius" type="float">0.5</param>
 +
                    <param sid="spread" name="Spread" type="float">0</param>
 +
                    <param sid="sunPos" name="Sun_Position" type="bool">false</param>
 +
                    <param sid="time" name="Time" type="float">12</param>
 +
                    <param sid="timeZone" name="Time_Zone" type="float">-8</param>
 +
                    <param sid="volumetrics" name="Volumetrics" type="bool">false</param>
 +
                    <param sid="vdissolve" name="Volumetrics_Dissolve" type="float">0</param>
 +
                    <param sid="vsamples" name="Volumetric_Samples" type="int">40</param>
 +
                </technique>
 +
            </extra>
 +
        </light>
 +
    </library_lights>

Revision as of 23:23, 17 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) Lighting (See list of specification categories)
Introduction: Describes custom light settings, including various light sub-types supported by modo 401.

Concepts

The modo render engine provides a general purpose collection of light settings and light sub-types, including both the basic directional, point, and spot lights specified by the common COLLADA technique, as well as more specialized light sub-types such as area lights and physically correct sunlights.
Attributes
Name Type Description Required?
sid xs:ncname A unique symbol within the technique; one for each param. Yes
Related Elements
Parent element(s) <visual_scene>
Extra and/or Technique <extra>/<technique profile="modo401">
Child elements None
Other
Child Elements
Name Description type Default Occurrences Named values
param sid="lightType" Name The sub-type of the light. N/A 1 See Details
.. .. .. .. .. ..

Details

Examples

   <library_lights>
       <light id="Light-Directional_Light" name="Directional_Light">
           <technique_common>
               <directional>
                   <color sid="directional_light_rgb">1 1 1</color>
               </directional>
           </technique_common>
           <extra>
               <technique profile="modo401">
                   <param sid="lightType" name="Light_Type" type="Name">sun_light</param>
                   <param sid="azimuth" name="Azimuth" type="float">0</param>
                   <param sid="clamp" name="Clamp_Intensity" type="bool">true</param>
                   <param sid="day" name="Day" type="int">2009172</param>
                   <param sid="elevation" name="Elevation" type="float">0</param>
                   <param sid="haze" name="Haze" type="float">2</param>
                   <param sid="height" name="Height" type="float">10</param>
                   <param sid="lat" name="Latitude" type="float">0.655057</param>
                   <param sid="lon" name="Longitude" type="float">-2.13456</param>
                   <param sid="mapSize" name="Map_Size" type="float">2</param>
                   <param sid="north" name="North" type="float">0</param>
                   <param sid="radius" name="Radius" type="float">0.5</param>
                   <param sid="spread" name="Spread" type="float">0</param>
                   <param sid="sunPos" name="Sun_Position" type="bool">false</param>
                   <param sid="time" name="Time" type="float">12</param>
                   <param sid="timeZone" name="Time_Zone" type="float">-8</param>
                   <param sid="volumetrics" name="Volumetrics" type="bool">false</param>
                   <param sid="vdissolve" name="Volumetrics_Dissolve" type="float">0</param>
                   <param sid="vsamples" name="Volumetric_Samples" type="int">40</param>
               </technique>
           </extra>
       </light>
   </library_lights>