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

From Reallusion Wiki!
Jump to: navigation, search
m
m
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
== Description ==
 
== Description ==
  
−
This class provides global settings and information for the application, like querying project related settings like [[#GetFps ( )|GetFps]], [[#GetTime ( )|GetTime]], [[#GetScreenSize|GetScreenSize]], etc., and operations such as [[#SetTime ( )|SetTime]], [[#RenderVideo ( )|RenderVideo]], etc.
+
This class provides global settings and information for the application, like querying project related settings like [[#GetFps ( )|GetFps]], [[#GetTime ( )|GetTime]], [[#GetScreenSize ( self, nWidth, nHeight )|GetScreenSize]], etc., and operations such as [[#SetTime ( )|SetTime]], [[#RenderVideo ( )|RenderVideo]], etc.
−
 
+
−
<syntaxhighlight lang="Python">
+
−
# Get Secen info
+
−
print(RLPy.RGlobal.GetProjectLength())                                    # print project length of the current scene
+
−
print(RLPy.RGlobal.GetFps())                                              # print 60 FPS
+
−
+
−
# Time info
+
−
RLPy.RGlobal.SetTime(RLPy.RTime(30000))                                  # set time to 30s
+
−
print(RLPy.RGlobal.GetTime().GetValue())                                  # print 30000
+
−
print(RLPy.RGlobal.GetStartTime().GetValue())                            # print start time
+
−
print(RLPy.RGlobal.GetEndTime().GetValue())                              # print end time
+
−
+
−
# play control
+
−
RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))                        # play form 0 to 1s
+
−
RLPy.RGlobal.Stop()                                                      # stop
+
−
RLPy.RGlobal.Pause()                                                      # pause
+
−
+
−
# Get Environment info
+
−
temp = ""
+
−
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp)                # print path, like: Temp,TemplateContent,CustomContent......
+
−
print(ret_list[1])
+
−
+
−
# undo / redo
+
−
RLPy.RGlobal.BeginAction("Motion")
+
−
# do something
+
−
RLPy.RGlobal.EndAction()
+
−
 
+
−
# Get Mocap Manager
+
−
mocap_manager = RLPy.RGlobal.GetMocapManager()
+
−
print(mocap_manager.IsRunning()) #true or false
+
−
 
+
−
# Remove All Animation
+
−
avatar_list = RLPy.RScene.GetAvatars()
+
−
result = RLPy.RGlobal.RemoveAllAnimations(avatar_list[0])
+
−
print(result)#RLPy.RStatus.Success or RLPy.RStatus.Failure
+
−
 
+
−
# Render Video
+
−
print(RLPy.RGlobal.RenderVideo())
+
−
#RLPy.RStatus.Success or RLPy.RStatus.Failure
+
−
 
+
−
# Get Screen Size
+
−
width = 0
+
−
height = 0
+
−
result = RLPy.RGlobal.GetScreenSize(width, height)
+
−
print(result[0]) #RLPy.RStatus.Success or RLPy.RStatus.Failure
+
−
print(result[1]) #screen width
+
−
print(result[2]) #screen height
+
−
</syntaxhighlight>
+
  
 
== Member Functions ==
 
== Member Functions ==
Line 62: Line 14:
  
 
==== Returns ====
 
==== Returns ====
−
:Project duration - RLPy.RTime
+
:Project duration - [[IC_Python_API:RLPy_RTime|RTime]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
print(RLPy.RGlobal.GetProjectLength()) # Print project duration for the current scene
−
print(RLPy.RGlobal.GetProjectLength()) # print project duration for the current scene
+
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 76: Line 27:
 
:Frame rate - int
 
:Frame rate - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
print(RLPy.RGlobal.GetFps()) # 60
−
print(RLPy.RGlobal.GetFps())
+
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 137: Line 87:
  
 
==== Parameters ====
 
==== Parameters ====
−
:ePath [IN] path type - RLPy.EPathType
+
:'''ePath''' [IN] path type - RLPy.EPathType
 
:*RLPy.EPathType_Temp
 
:*RLPy.EPathType_Temp
 
:*RLPy.EPathType_TemplateContent
 
:*RLPy.EPathType_TemplateContent
Line 154: Line 104:
 
:*RLPy.EPathType_CustomWidget
 
:*RLPy.EPathType_CustomWidget
 
:*RLPy.EPathType_iCloneAssets
 
:*RLPy.EPathType_iCloneAssets
−
:strPath [OUT] path name - string
+
:'''strPath''' [OUT] path name - string
  
 
==== Returns ====
 
==== Returns ====
 
:Success - RLPy.RStatus.Success
 
:Success - RLPy.RStatus.Success
−
:Fail - RLPy.RStatus.Failure  
+
:Failure - RLPy.RStatus.Failure  
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
temp = ""
 
temp = ""
 
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp)
 
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp)
Line 173: Line 122:
  
 
==== Parameters ====
 
==== Parameters ====
−
:strAction [IN] action name - string
+
:'''strAction''' [IN] action name - string
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
RLPy.RGlobal.BeginAction('ActionName')
 
RLPy.RGlobal.BeginAction('ActionName')
 
RLPy.RGlobal.EndAction()
 
RLPy.RGlobal.EndAction()
Line 185: Line 133:
 
Perform undo and redo actions.  This function is currently incomplete
 
Perform undo and redo actions.  This function is currently incomplete
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
 +
# undo / redo
 +
RLPy.RGlobal.BeginAction("Motion")
 +
# do something
 +
RLPy.RGlobal.EndAction()
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 193: Line 145:
  
 
==== Parameters ====
 
==== Parameters ====
−
:kStart [IN] start time - RLPy.RTime
+
:'''kStart''' [IN] start time - [[IC_Python_API:RLPy_RTime|RTime]]
−
:kEnd [IN] end time - RLPy.RTime
+
:'''kEnd''' [IN] end time - [[IC_Python_API:RLPy_RTime|RTime]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
start_time = RLPy.RTime(0)
 
start_time = RLPy.RTime(0)
 
end_time = RLPy.RTime(1000.0)
 
end_time = RLPy.RTime(1000.0)
Line 207: Line 158:
 
Pause the timeline playback and keep the playhead in place.
 
Pause the timeline playback and keep the playhead in place.
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
 
RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
 
RLPy.RGlobal.Pause()
 
RLPy.RGlobal.Pause()
Line 217: Line 167:
 
Stop the timeline playback and return the playhead to the start marker.
 
Stop the timeline playback and return the playhead to the start marker.
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
 
RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
 
RLPy.RGlobal.Stop()
 
RLPy.RGlobal.Stop()
Line 230: Line 179:
 
:Returns true when application playing - bool
 
:Returns true when application playing - bool
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
if(not RLPy.RGlobal.IsPlaying()):
 
if(not RLPy.RGlobal.IsPlaying()):
 
         RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
 
         RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
Line 243: Line 191:
  
 
==== Returns ====
 
==== Returns ====
−
:current time - RLPy.RTime
+
:current time - [[IC_Python_API:RLPy_RTime|RTime]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
time = RLPy.RGlobal.GetTime()
 
time = RLPy.RGlobal.GetTime()
 
print(time)
 
print(time)
Line 255: Line 202:
 
Change the current time for the scene and update the playhead.
 
Change the current time for the scene and update the playhead.
  
−
See Also: GetTime
+
See Also: [[#GetTime ( )|GetTime]]
  
 
==== Parameters ====
 
==== Parameters ====
−
:kTime [IN] Specifies the time to set - RLPy.RTime
+
:'''kTime''' [IN] Specifies the time to set - [[IC_Python_API:RLPy_RTime|RTime]]
  
 
==== Returns ====
 
==== Returns ====
 
:Success - RLPy.RStatus.Success
 
:Success - RLPy.RStatus.Success
−
:Fail - RLPy.RStatus.Failure
+
:Failure - RLPy.RStatus.Failure
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
result = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
 
result = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
 
print(result) # Success or fail
 
print(result) # Success or fail
Line 278: Line 224:
  
 
==== Returns ====
 
==== Returns ====
−
:Start frame time - RLPy.RTime
+
:Start frame time - [[IC_Python_API:RLPy_RTime|RTime]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
time = RLPy.RGlobal.GetStartTime()
 
time = RLPy.RGlobal.GetStartTime()
 
print(time)
 
print(time)
Line 291: Line 236:
  
 
==== Returns ====
 
==== Returns ====
−
:End frame time - RLPy.RTime
+
:End frame time - [[IC_Python_API:RLPy_RTime|RTime]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
time = RLPy.RGlobal.GetEndTime()
 
time = RLPy.RGlobal.GetEndTime()
 
print(time)
 
print(time)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=== GetMocapManager () ===
+
=== GetMocapManager ( ) ===
  
−
Access the Mocap Manager and member functions for RLPy.RIMocapManager.
+
Access the Mocap Manager and member functions for [[IC_Python_API:RLPy_RIMocapManager|RIMocapManager]].
  
 
See Also: [[IC_Python_API:RLPy_RIMocapManager|RIMocapManager]]
 
See Also: [[IC_Python_API:RLPy_RIMocapManager|RIMocapManager]]
  
 
==== Returns ====
 
==== Returns ====
−
:Pointer to mocap manager - RLPy.RIMocapManager
+
:Pointer to mocap manager - [[IC_Python_API:RLPy_RIMocapManager|RIMocapManager]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
mocap_manager = RLPy.RGlobal.GetMocapManager()
 
mocap_manager = RLPy.RGlobal.GetMocapManager()
−
print(mocap_manager.IsRunning())
+
print(mocap_manager.IsRunning()) # True or False
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 319: Line 262:
  
 
==== Parameters ====
 
==== Parameters ====
−
:spObject [IN] The object to remove animations - RLPy.RIObject
+
:'''spObject''' [IN] The object to remove animations - [[IC_Python_API:RLPy_RIObject|RIObject]]
  
 
==== Returns ====
 
==== Returns ====
Line 325: Line 268:
 
:Failure - RLPy.RStatus.Failure
 
:Failure - RLPy.RStatus.Failure
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
result = RLPy.RGlobal.RemoveAllAnimations( avatar_list[0] )
 
result = RLPy.RGlobal.RemoveAllAnimations( avatar_list[0] )
Line 332: Line 274:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=== RenderVideo () ===
+
=== RenderVideo ( ) ===
  
 
Use the current iClone render settings to output a video.  Returns '''RLPy.RStatus.Success''' when successful, else '''RLPy.RStatus.Failure'''.
 
Use the current iClone render settings to output a video.  Returns '''RLPy.RStatus.Success''' when successful, else '''RLPy.RStatus.Failure'''.
Line 340: Line 282:
 
:Failure - RLPy.RStatus.Failure
 
:Failure - RLPy.RStatus.Failure
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
result = RLPy.RGlobal.RenderVideo()
 
result = RLPy.RGlobal.RenderVideo()
 
print(result)
 
print(result)
Line 351: Line 292:
  
 
==== Parameters ====
 
==== Parameters ====
−
:nWidth [IN] screen width in pixels - int
+
:'''nWidth''' [IN] screen width in pixels - int
−
:nHeight [IN] screen height in pixels - int
+
:'''nHeight''' [IN] screen height in pixels - int
  
 
==== Returns ====
 
==== Returns ====
Line 361: Line 302:
 
::Height - int
 
::Height - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
import RLPy
+
 
width = 0
 
width = 0
 
height = 0
 
height = 0

Latest revision as of 00:05, 14 April 2020

Main article: Modules.
Last modified: 04/14/2020

Description

This class provides global settings and information for the application, like querying project related settings like GetFps, GetTime, GetScreenSize, etc., and operations such as SetTime, RenderVideo, etc.

Member Functions

GetProjectLength ( )

Get the current project duration.

Returns

Project duration - RTime
1 print(RLPy.RGlobal.GetProjectLength()) # Print project duration for the current scene

GetFps ( )

Get the frames-per-second for the current project. Currently fixed at 60 fps.

Returns

Frame rate - int
1 print(RLPy.RGlobal.GetFps()) # 60

GetPath ( )

This function can return the absolute paths for the following directories:

RLPy.EPathType_Temp Temporary folder
RLPy.EPathType_TemplateContent Template content folder
RLPy.EPathType_CustomContent Custom content folder
RLPy.EPathType_ProgramDefault Program default folder
RLPy.EPathType_Morph Morph data folder
RLPy.EPathType_CreateFace CreateFace data folder
RLPy.EPathType_Puppet Puppet data folder
RLPy.EPathType_FacialLayer Facial layer data folder
RLPy.EPathType_ShareTemplateContent Shared template content folder
RLPy.EPathType_Thumb Thumbnail folder
RLPy.EPathType_Image Image folder
RLPy.EPathType_CreatorAssets Creator assets folder
RLPy.EPathType_Resource Resource folder
RLPy.EPathType_FacialSystem Facial system folder
RLPy.EPathType_CustomWidget Custom widget folder
RLPy.EPathType_iCloneAssets iClone assets folder

Parameters

ePath [IN] path type - RLPy.EPathType
  • RLPy.EPathType_Temp
  • RLPy.EPathType_TemplateContent
  • RLPy.EPathType_CustomContent
  • RLPy.EPathType_ProgramDefault
  • RLPy.EPathType_Morph
  • RLPy.EPathType_CreateFace
  • RLPy.EPathType_Puppet
  • RLPy.EPathType_FacialLayer
  • RLPy.EPathType_ShareTemplateContent
  • RLPy.EPathType_Thumb
  • RLPy.EPathType_Image
  • RLPy.EPathType_CreatorAssets
  • RLPy.EPathType_Resource
  • RLPy.EPathType_FacialSystem
  • RLPy.EPathType_CustomWidget
  • RLPy.EPathType_iCloneAssets
strPath [OUT] path name - string

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure 
1 temp = ""
2 ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp)
3 print(ret_list[0]) # success or faild
4 print(ret_list[1]) # path

BeginAction ( )

Perform undo and redo actions. This function is currently incomplete.

Parameters

strAction [IN] action name - string
1 RLPy.RGlobal.BeginAction('ActionName')
2 RLPy.RGlobal.EndAction()

EndAction ( )

Perform undo and redo actions. This function is currently incomplete 

1 # undo / redo
2 RLPy.RGlobal.BeginAction("Motion")
3 # do something
4 RLPy.RGlobal.EndAction()

Play ( )

Controls the timeline playback.

Parameters

kStart [IN] start time - RTime
kEnd [IN] end time - RTime
1 start_time = RLPy.RTime(0)
2 end_time = RLPy.RTime(1000.0)
3 RLPy.RGlobal.Play(start_time,end_time)

Pause ( )

Pause the timeline playback and keep the playhead in place. 

1 RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
2 RLPy.RGlobal.Pause()

Stop ( )

Stop the timeline playback and return the playhead to the start marker. 

1 RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
2 RLPy.RGlobal.Stop()

IsPlaying ( )

Check if timeline playback is in progress.

Returns

Returns true when application playing - bool
1 if(not RLPy.RGlobal.IsPlaying()):
2         RLPy.RGlobal.Play(RLPy.RTime(0), RLPy.RTime(1000))
3 if(RLPy.RGlobal.IsPlaying()):
4         RLPy.RGlobal.Stop()

GetTime ( )

Get the current time for the scene according to the location of the playhead.

Returns

current time - RTime
1 time = RLPy.RGlobal.GetTime()
2 print(time)

SetTime ( )

Change the current time for the scene and update the playhead.

See Also: GetTime

Parameters

kTime [IN] Specifies the time to set - RTime

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
1 result = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
2 print(result) # Success or fail
3 
4 time = RLPy.RGlobal.GetTime()
5 print(time)

GetStartTime ( )

Get the start time for the current project.

Returns

Start frame time - RTime
1 time = RLPy.RGlobal.GetStartTime()
2 print(time)

GetEndTime ( )

Get the end time for the current project.

Returns

End frame time - RTime
1 time = RLPy.RGlobal.GetEndTime()
2 print(time)

GetMocapManager ( )

Access the Mocap Manager and member functions for RIMocapManager.

See Also: RIMocapManager

Returns

Pointer to mocap manager - RIMocapManager
1 mocap_manager = RLPy.RGlobal.GetMocapManager()
2 print(mocap_manager.IsRunning()) # True or False

RemoveAllAnimations ( spObject )

Remove all animations on a given object and return RLPy.RStatus.Success if successful, else RLPy.RStatus.Failure. Currently supports characters, props, accessories, particles, PopcornFX, lights, motion paths, cameras, wind, images, and global illumination. The timeline needs to update after execution in order to show the changes.

Parameters

spObject [IN] The object to remove animations - RIObject

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
1 avatar_list = RLPy.RScene.GetAvatars()
2 result = RLPy.RGlobal.RemoveAllAnimations( avatar_list[0] )
3 print(result)

RenderVideo ( )

Use the current iClone render settings to output a video. Returns RLPy.RStatus.Success when successful, else RLPy.RStatus.Failure.

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
1 result = RLPy.RGlobal.RenderVideo()
2 print(result)

GetScreenSize ( self, nWidth, nHeight )

Get the render output size for the current scene.

Parameters

nWidth [IN] screen width in pixels - int
nHeight [IN] screen height in pixels - int

Returns

[Success/Fail, Width, Height] - list
Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
Width - int
Height - int
1 width = 0
2 height = 0
3 result = RLPy.RGlobal.GetScreenSize(width, height)
4 print(result[0]) # successful or failed
5 print(result[1]) # width
6 print(result[2]) # height
Retrieved from "http://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RGlobal&oldid=4526"