Difference between revisions of "Experimental:FBX COMP"

From TouchDesigner Documentation
Jump to: navigation, search
(ready for new experimental)
(Tag: Blanking)
 
Line 1: Line 1:
{{Summary
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|opLabel=FBX
 
|opClass=fbxCOMP_Class
 
|opFilter=True
 
|opLicense=Non-Commercial
 
|short=
 
|long=The FBX COMP imports geometry, animations and scenes using the FBX file format from Maya, 3DS Max, Cinema4D, Houdini and others
 
The FBX COMP currently uses the 2017.1 version of the FBX SDK.
 
  
FBX is a file format and set of libraries from Autodesk that is used to exchange models, animations and image/texture data between applications. The FBX COMP reads FBX files and supports most of its features. You can drag-drop a .fbx into a TouchDesigner network, or import it via the FBX File parameter. See also [[File Types]].
 
 
The assets from the FBX file are saved into a ".tdc" file with the same name as the FBX file inside the TDImportCache, which is created next to your toe file. Assets are read from the ".tdc" file using Import Select OPs (Import Select TOP/SOP/CHOP). Upon reloading a toe file, the assets can be imported directly from the ".tdc" cache, and so the FBX file will not need to be reimported. However, if there is no existing ".tdc" (for instance, if the toe file changed computers) then the FBX file will be reopened to grab the assets and a new ".tdc" will be saved out.
 
 
To open a FBX file in TouchDesigner:
 
 
1) Specify a valid file path including the name of the file with correct .fbx extension.
 
 
2) This step is varied depending on whether the FBX COMP is just created and if any changes in the default values of parameters are required or not. If the file is being loaded for the first time in the network and the default parameter values are accepted then it is sufficient to press the "Build Network" to generate the FBX network. Note that we recommend toggling the "Merge Geometry" for any medium or large files as it can significantly affect the performance. Generally, any changes in the parameters above the "Build Network" requires the network to be built again.
 
 
3) The "Reload" button is being used for reloading the internal assets (e.g. meshes, etc.) and this is specifically useful if the file has moved to another location and so when the toe file is reloaded the assets cannot be reloaded properly.
 
 
4) The "Update" button is used when some changes on FBX file are made and we want to merge those changes into the current network without fully rebuilding it.
 
 
See also: [[FBX]], [[Import Select CHOP]], [[Import Select TOP]], [[Import Select SOP]].
 
}}
 
{{ParameterPage
 
|opFamily=COMP
 
|pageName=FBX
 
|pageSummary='''NOTE:''' changes to any of the below parameters aren’t applied until the FBX File is rebuilt, either through Build Network or Update.
 
|items={{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=FBX File
 
|parName=file
 
|parType=filepath load
 
|parReadOnly=False
 
|parOrder=0
 
|parSummary=The FBX file to import.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Reload File
 
|parName=reload
 
|parType=button
 
|parReadOnly=False
 
|parOrder=7
 
|parSummary=A pulse to reload the contents of the assets from the file without making any changes to the existing network.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Lights
 
|parName=lights
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=1
 
|parSummary=When enabled the FBX COMP will import any lights within the FBX File.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Cameras
 
|parName=cameras
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=2
 
|parSummary=When enabled the FBX COMP will import any cameras within the FBX File.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Generate Actor COMPs
 
|parName=genactors
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=3
 
|parSummary=When enabled, will generate Actor COMPs in place of Geometry COMPs as the parents' of Import Select SOPs.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Merge Geos
 
|parName=mergegeos
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=4
 
|parSummary=When enabled the FBX COMP will merge Geometry COMPs. Geometry COMPs are merged if they have only default parameters except transform. Or if they have the same material then their Import Select SOPs will be merged.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Merge Level
 
|parName=mergelevel
 
|parType=integer
 
|parReadOnly=False
 
|parOrder=5
 
|parSummary=When enabled the FBX COMP will attempt to merge up to the desired “level”. Level is how many steps down a node is from the root (FBX COMP). If its level is higher than the merge level and it is mergeable then it will be merged upward.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Primitive Groups
 
|parName=primgroups
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=6
 
|parSummary=When enabled the FBX COMP will put each merged SOP into its own primitive group, so that they can be split up later if need be.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Max Wired Children
 
|parName=maxwiredchildren
 
|parType=integer
 
|parReadOnly=False
 
|parOrder=7
 
|parSummary=When this is enabled, any COMPs that have more wired children than this parameter will have those wired children will be converted to children of the COMP.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Build Network
 
|parName=buildnetwork
 
|parType=button
 
|parReadOnly=False
 
|parOrder=8
 
|parSummary=Performs a clean import of the FBX file. Builds the network from the imported file with the above parameters. If there are any nodes inside the FBX COMP they will be removed prior to importing.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Keep Parameters
 
|parName=keepparams
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=9
 
|parSummary=When enabled, any parameter conflicts will be resolved in favour of user changes. When disabled, any user changes to parameters may be overwritten.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Keep Connections
 
|parName=keepconnections
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=10
 
|parSummary=When enabled, any wirings/connections conflicts will be resolved in favour of user changes. When disabled, any user changes to wirings/connections may be overwritten.
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Update
 
|parName=update
 
|parType=button
 
|parReadOnly=False
 
|parOrder=11
 
|parSummary=Imports the FBX file with the above parameters and with the above merge conditions and merges it with what is currently inside the FBX COMP, therefore maintaining your changes. This parameter should be used if the FBX file is modified and those changes need to be reflected in TouchDesigner/
 
|parItems=}}}}
 
    {{ParameterPage
 
|opFamily=COMP
 
|pageName=Play
 
|pageSummary=
 
|items={{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Animation
 
|parName=animation
 
|parType=minimenu dynamicmenu
 
|parReadOnly=False
 
|parOrder=0
 
|parSummary=
 
|parItems=}}
 
    {{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Shift Animation Start
 
|parName=shiftanimationstart
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=1
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Sample Rate Mode
 
|parName=sampleratemode
 
|parType=dropmenu
 
|parReadOnly=False
 
|parOrder=2
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=sampleratemode
 
|itemLabel=File FPS
 
|itemName=filefps
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=sampleratemode
 
|itemLabel=Custom
 
|itemName=custom
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Sample Rate
 
|parName=samplerate
 
|parType=float
 
|parReadOnly=False
 
|parOrder=3
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Play Mode
 
|parName=playmode
 
|parType=dropmenu
 
|parReadOnly=False
 
|parOrder=4
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=playmode
 
|itemLabel=Locked to Timeline
 
|itemName=lockedtotimeline
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=playmode
 
|itemLabel=Specify Index
 
|itemName=specifyindex
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=playmode
 
|itemLabel=Sequential
 
|itemName=sequential
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Index
 
|parName=index
 
|parType=joinpair float
 
|parReadOnly=False
 
|parOrder=5
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Index Unit
 
|parName=indexunit
 
|parType=nolabel shortvalues dropmenu
 
|parReadOnly=False
 
|parOrder=6
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=indexunit
 
|itemLabel=Frames
 
|itemName=frames
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=indexunit
 
|itemLabel=Seconds
 
|itemName=seconds
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=indexunit
 
|itemLabel=Fraction
 
|itemName=fraction
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=indexunit
 
|itemLabel=Index
 
|itemName=indices
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Play
 
|parName=play
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=7
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Speed
 
|parName=speed
 
|parType=float
 
|parReadOnly=False
 
|parOrder=8
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Trim
 
|parName=trim
 
|parType=toggle
 
|parReadOnly=False
 
|parOrder=9
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Trim Start
 
|parName=tstart
 
|parType=joinpair float
 
|parReadOnly=False
 
|parOrder=10
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Trim Start Unit
 
|parName=tstartunit
 
|parType=nolabel shortvalues dropmenu
 
|parReadOnly=False
 
|parOrder=11
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=tstartunit
 
|itemLabel=Frames
 
|itemName=frames
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tstartunit
 
|itemLabel=Seconds
 
|itemName=seconds
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tstartunit
 
|itemLabel=Fraction
 
|itemName=fraction
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tstartunit
 
|itemLabel=Index
 
|itemName=indices
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Trim End
 
|parName=tend
 
|parType=joinpair float
 
|parReadOnly=False
 
|parOrder=12
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Trim End Unit
 
|parName=tendunit
 
|parType=nolabel shortvalues dropmenu
 
|parReadOnly=False
 
|parOrder=13
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=tendunit
 
|itemLabel=Frames
 
|itemName=frames
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tendunit
 
|itemLabel=Seconds
 
|itemName=seconds
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tendunit
 
|itemLabel=Fraction
 
|itemName=fraction
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=tendunit
 
|itemLabel=Index
 
|itemName=indices
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Cue
 
|parName=cue
 
|parType=joinpair toggle
 
|parReadOnly=False
 
|parOrder=14
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Cue Pulse
 
|parName=cuepulse
 
|parType=nolabel button
 
|parReadOnly=False
 
|parOrder=15
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Cue Point
 
|parName=cuepoint
 
|parType=joinpair float
 
|parReadOnly=False
 
|parOrder=16
 
|parSummary=
 
|parItems=}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Cue Point Unit
 
|parName=cuepointunit
 
|parType=nolabel shortvalues dropmenu
 
|parReadOnly=False
 
|parOrder=17
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=cuepointunit
 
|itemLabel=Frames
 
|itemName=frames
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=cuepointunit
 
|itemLabel=Seconds
 
|itemName=seconds
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=cuepointunit
 
|itemLabel=Fraction
 
|itemName=fraction
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=cuepointunit
 
|itemLabel=Index
 
|itemName=indices
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Extend Left
 
|parName=textendleft
 
|parType=dropmenu
 
|parReadOnly=False
 
|parOrder=18
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=textendleft
 
|itemLabel=Hold
 
|itemName=hold
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=textendleft
 
|itemLabel=Cycle
 
|itemName=cycle
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=textendleft
 
|itemLabel=Mirror
 
|itemName=mirror
 
|itemSummary=}}}}{{Parameter
 
|opFamily=COMP
 
|opType=fbxCOMP
 
|parLabel=Extend Right
 
|parName=textendright
 
|parType=dropmenu
 
|parReadOnly=False
 
|parOrder=19
 
|parSummary=
 
|parItems={{ParameterItem
 
|opFamily=COMP
 
|parName=textendright
 
|itemLabel=Hold
 
|itemName=hold
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=textendright
 
|itemLabel=Cycle
 
|itemName=cycle
 
|itemSummary=}}<!--
 
-->{{ParameterItem
 
|opFamily=COMP
 
|parName=textendright
 
|itemLabel=Mirror
 
|itemName=mirror
 
|itemSummary=}}}}}}{{:COMP Xform Page}}{{:COMP Pre-Xform Page}}{{:COMP Render Page}}{{:COMP Extensions Page}}{{:COMP Filter Common Page}}{{History}}{{NavBox
 
|Category=COMPs}}{{#invoke:Category
 
|list
 
|COMPs}}
 

Latest revision as of 11:34, 6 May 2019