Difference between revisions of "IC Python API:RLPy RFileIO"

From Reallusion Wiki!
Jump to: navigation, search
(Created page with "{{TOC}} {{Parent|IC_Python_API:RL_Python_Modules|Modules}} == Detailed Description == This class provides I/O operations on the scene files. <syntaxhighlight lang="Python"> #...")
 
m
Line 1: Line 1:
{{TOC}}
+
{|class="wikitable"
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
+
!scope="row"|Avatar
== Detailed Description ==
+
|iavatar||iacc||ihair||iupper||ilower||ishoe||iglove||iskin||icloth||iteeth||aml || || || ||
This class provides I/O operations on the scene files.
+
|-
<syntaxhighlight lang="Python">
+
!scope="row"|Head
# load project file
+
|iface||ieye||ioral||rlhead|| || || || || || || || || || ||
file_path = "c:/myProject.iProject"
+
|-
RLPy.RFileIO.LoadFile(file_path)
+
!scope="row"|Props
 
+
|iprop||itree||igrass||iparticle||ipkfx||iTerrain||iwater||isky|| || || || || || ||
# load object
+
|-
object = RLPy.RFileIO.LoadObject("C:/CC_Standard_Neutral.iavatar")
+
!scope="row"|Animation
print(type(object)) #RLPy.RIAvatar
+
|imotion||imotionplus||rlmotion||ihand||italk||rltalk||ipath|| || || || || || || ||
 
+
|-
object = RLPy.RFileIO.LoadObject("C:/Arc_001.iProp")
+
!scope="row"|Scene
print(type(object)) #RLPy.RIProp
+
|iimglayer||iscene||iatm||ifog||icam||ilight||ieffect||imtl||imtlplus||sbsar||itol||iscript||lua||cclightroom||isubstance
</syntaxhighlight>
+
|-
==Member Functions==
+
!scope="row"|Image
===LoadAlembicFile===
+
|jpg||jpeg||bmp||gif||png||hdr||exr||tga||Audio||mp3||wma||m4a||aac||wav ||
<syntaxhighlight lang="Python">
+
|-
RLPy.RFileIO.LoadAlembicFile ( spObject, strFilePath, eUpAxis )
+
!scope="row"|Video
</syntaxhighlight>
+
|avi||mv||mpeg||mpg||mpe||mp4||mkv||rm||rmvb||asf||asx||wm||mov||flv ||
Import the alembic file from the given file into the current scene.
+
|-
====Parameters====
+
!scope="row"|iSprite
<div style="margin-left: 2em;">
+
|popvideo||iwidget || || || || || || || || || || || || ||
 
+
|-
'''spObject''' [IN] target object - RLPy.RIObject
+
!scope="row"|Physics Constraint
 
+
|iconstraint || || || || || || || || || || || || || ||
'''strFilePath''' [IN] file path - string
+
|-
 
+
!scope="row"|Advertise thumbnail
'''eUpAxis''' [IN] coordinate axis - RLPy.ECoordinateAxis
+
|rladv || || || || || || || || || || || || || ||
*'''RLPy.ECoordinateAxis_X'''
+
|-
*'''RLPy.ECoordinateAxis_NegativeX'''
+
!scope="row"|Model
*'''RLPy.ECoordinateAxis_Y'''
+
|abc||obj||fbx || || || || || || || || || || || ||
*'''RLPy.ECoordinateAxis_NegativeY'''
+
|}
*'''RLPy.ECoordinateAxis_Z'''
+
*'''RLPy.ECoordinateAxis_NegativeZ'''
+
</div>
+
====Return Values====
+
<div style="margin-left: 2em;">
+
 
+
'''RLPy.RStatus.Success''' Success
+
 
+
'''RLPy.RStatus.Failure''' Fail
+
</div>
+
-----
+
===LoadFile===
+
<syntaxhighlight lang="Python">
+
RLPy.RFileIO.LoadFile ( strFilePath )
+
</syntaxhighlight>
+
Import the scene elements from the given file into the current scene.
+
Current supported file types: All iClone supported file format.
+
====Parameters====
+
<div style="margin-left: 2em;">
+
 
+
'''strFilePath''' [IN] file path - string
+
</div>
+
====Return Values====
+
<div style="margin-left: 2em;">
+
 
+
'''RLPy.RStatus.Success''' Success
+
 
+
'''RLPy.RStatus.Failure''' Fail
+
</div>
+
-----
+
===LoadObject===
+
<syntaxhighlight lang="Python">
+
RLPy.RFileIO.LoadObject ( strFilePath )
+
</syntaxhighlight>
+
Import the scene elements from the given file into the current scene.
+
Current supported file types: Only the file type of the object. <span style="background:#ffcccc">( Experimental API )</span>
+
====Parameters====
+
<div style="margin-left: 2em;">
+
 
+
'''strFilePath''' [IN] file path - string
+
</div>
+
====Return Values====
+
<div style="margin-left: 2em;">
+
 
+
'''RIObjectPtr''' The requested object returned as a Type.
+
</div>
+

Revision as of 02:39, 23 March 2020

Avatar iavatar iacc ihair iupper ilower ishoe iglove iskin icloth iteeth aml
Head iface ieye ioral rlhead
Props iprop itree igrass iparticle ipkfx iTerrain iwater isky
Animation imotion imotionplus rlmotion ihand italk rltalk ipath
Scene iimglayer iscene iatm ifog icam ilight ieffect imtl imtlplus sbsar itol iscript lua cclightroom isubstance
Image jpg jpeg bmp gif png hdr exr tga Audio mp3 wma m4a aac wav
Video avi mv mpeg mpg mpe mp4 mkv rm rmvb asf asx wm mov flv
iSprite popvideo iwidget
Physics Constraint iconstraint
Advertise thumbnail rladv
Model abc obj fbx