Visual scene modo 401 extension: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
More details...
m Fixed the e-mail address.
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{extension
{{extension
  | company = yourcompanyname
  | company = Luxology
  | purpose = short description
  | purpose = Range of time and time system
| 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.  
Line 18: Line 17:


===Concepts===
===Concepts===
:<!-- Background info needed to understand this element's purpose and place within COLLADA -->
:Working with animated sequences within the context of film, TV, or simulation often requires an overall scene start and end time, with a time system used for display purposes, which is chosen according to the context in which the animation is used. <!-- Background info needed to understand this element's purpose and place within COLLADA -->
 
:{| {{prettytable}}
:{| {{prettytable}}
|+ '''Attributes'''
|+ '''Attributes'''
!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 value.||Yes
|-
|name||xs:ncname||A user-friendly name for the param.||No
|}
|}


Line 30: Line 30:
|+ '''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
!sid||name||Description||type||Default||Occurrences||Named values
|-
|currentS||Scene_Current_Start_Time||Current start time of the scene.||float||0||0 or 1||
|-
|currentE||Scene_Current_End_Time||Current end time of the scene.||float||5||0 or 1||
|-
|fps||Scene_FPS||Number of frames per second.||float||24||1||
|-
|sceneS||Scene_Start_Time||Start time of the scene.||float||0||1||
|-
|sceneE||Scene_End_Time||End time of the scene.||float||5||1||
|-
|-
|Example||Specifies foo.||N/A||0 or more
|timeSys||Scene_Time_System||Time system used to display times.||Name||frames||0 or 1||filmcode, frames, seconds, smpte
|}
|}


===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 end times should be greater than or equal to the start times.
:The time system does not affect the internal representation of the time values used by modo, nor their textual representation in the COLLADA data; the time values are always specified in seconds.
:modo 401 stores a per-scene up axis setting in an asset element within the visual scene, as shown in the example below.
<!-- 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===
Line 56: Line 69:
     <library_visual_scenes>
     <library_visual_scenes>
         <visual_scene id="DefaultScene">
         <visual_scene id="DefaultScene">
            <asset>
                <created>2009-08-20T21:29:49Z</created>
                <modified>2009-08-20T21:29:49Z</modified>
                <up_axis>Z_UP</up_axis>
            </asset>
            ...
             <extra>
             <extra>
                 <technique profile="modo401">
                 <technique profile="modo401">
Line 64: Line 83:
                     <param sid="sceneE" name="Scene_End_Time" type="float">5</param>
                     <param sid="sceneE" name="Scene_End_Time" type="float">5</param>
                     <param sid="timeSys" name="Scene_Time_System" type="Name">frames</param>
                     <param sid="timeSys" name="Scene_Time_System" type="Name">frames</param>
                    <param sid="upAxis" name="Scene_Up_Axis" type="Name">Y_UP</param>
                 </technique>
                 </technique>
             </extra>
             </extra>
         </visual_scene>
         </visual_scene>
     </library_visual_scenes>
     </library_visual_scenes>

Latest revision as of 21:56, 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) Scene (See list of specification categories)
Introduction: Describes a range of time for a scene and its time system.

Concepts

Working with animated sequences within the context of film, TV, or simulation often requires an overall scene start and end time, with a time system used for display purposes, which is chosen according to the context in which the animation is used.
Attributes
Name Type Description Required?
sid xs:ncname A unique symbol within the technique; one for each value. Yes
name xs:ncname A user-friendly name for the param. No
Related Elements
Parent element(s) <visual_scene>
Extra and/or Technique <extra>/<technique profile="modo401">
Child elements None
Other
Child Elements
sid name Description type Default Occurrences Named values
currentS Scene_Current_Start_Time Current start time of the scene. float 0 0 or 1
currentE Scene_Current_End_Time Current end time of the scene. float 5 0 or 1
fps Scene_FPS Number of frames per second. float 24 1
sceneS Scene_Start_Time Start time of the scene. float 0 1
sceneE Scene_End_Time End time of the scene. float 5 1
timeSys Scene_Time_System Time system used to display times. Name frames 0 or 1 filmcode, frames, seconds, smpte

Details

The end times should be greater than or equal to the start times.
The time system does not affect the internal representation of the time values used by modo, nor their textual representation in the COLLADA data; the time values are always specified in seconds.
modo 401 stores a per-scene up axis setting in an asset element within the visual scene, as shown in the example below.

Examples

   <library_visual_scenes>
       <visual_scene id="DefaultScene">
           <asset>
               <created>2009-08-20T21:29:49Z</created>
               <modified>2009-08-20T21:29:49Z</modified>
               <up_axis>Z_UP</up_axis>
           </asset>
           ...
           <extra>
               <technique profile="modo401">
                   <param sid="currentS" name="Scene_Current_Start_Time" type="float">0</param>
                   <param sid="currentE" name="Scene_Current_End_Time" type="float">5</param>
                   <param sid="fps" name="Scene_FPS" type="float">24</param>
                   <param sid="sceneS" name="Scene_Start_Time" type="float">0</param>
                   <param sid="sceneE" name="Scene_End_Time" type="float">5</param>
                   <param sid="timeSys" name="Scene_Time_System" type="Name">frames</param>
               </technique>
           </extra>
       </visual_scene>
   </library_visual_scenes>