Difference between revisions of "IC Python API:RLPy RGlobal"
Chuck (RL) (Talk | contribs) m |
Chuck (RL) (Talk | contribs) m |
||
| Line 101: | Line 101: | ||
Frame rate - int | Frame rate - int | ||
</div> | </div> | ||
| + | <syntaxhighlight lang="Python"> | ||
| + | # Get the project frames per second. | ||
| + | |||
| + | import RLPy | ||
| + | # Get frames per second | ||
| + | print(RLPy.RGlobal.GetFps()) | ||
| + | |||
| + | #60 | ||
| + | </syntaxhighlight> | ||
----- | ----- | ||
=== GetMocapManager === | === GetMocapManager === | ||
| Line 145: | Line 154: | ||
'''RLPy.RStatus.Failure''' Fail | '''RLPy.RStatus.Failure''' Fail | ||
</div> | </div> | ||
| + | <syntaxhighlight lang="Python"> | ||
| + | # Print out a few path locations (Individual path locations may vary). | ||
| + | |||
| + | import RLPy | ||
| + | |||
| + | temp = "" | ||
| + | ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp) | ||
| + | print("Temp folder: "+ret_list[1]) | ||
| + | |||
| + | # Temp folder: C:\Users\User_Name\AppData\Local\Temp\iClone7Temp\iClone7Temp\ | ||
| + | |||
| + | ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_TemplateContent, temp) | ||
| + | print("Template content folder: "+ret_list[1]) | ||
| + | |||
| + | # Template content folder: C:\Users\Public\Documents\Reallusion\Template\iClone 7 Template | ||
| + | |||
| + | ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_CustomContent, temp) | ||
| + | print("Custom content folder: "+ret_list[1]) | ||
| + | |||
| + | # Custom content folder: C:\Users\Public\Documents\Reallusion\Custom\iClone 7 Custom | ||
| + | |||
| + | ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_ProgramDefault, temp) | ||
| + | print("Program default folder: "+ret_list[1]) | ||
| + | |||
| + | # Program default folder: C:\Program Files\Reallusion\iClone 7\Program\Default\ | ||
| + | |||
| + | </syntaxhighlight> | ||
----- | ----- | ||
=== GetProjectLength === | === GetProjectLength === | ||
| Line 155: | Line 191: | ||
Project length - RLPy.RTime | Project length - RLPy.RTime | ||
</div> | </div> | ||
| + | <syntaxhighlight lang="Python"> | ||
| + | # Retrieve the length of the project in ms. | ||
| + | |||
| + | import RLPy | ||
| + | |||
| + | # Fetch the current frame time in milliseconds. | ||
| + | time = RLPy.RGlobal.GetTime() | ||
| + | |||
| + | # Return the current frame time in milliseconds. | ||
| + | print(time.GetValue()) | ||
| + | </syntaxhighlight> | ||
----- | ----- | ||
=== GetStartTime === | === GetStartTime === | ||
| Line 185: | Line 232: | ||
True when application playing - bool | True when application playing - bool | ||
</div> | </div> | ||
| + | <syntaxhighlight lang="Python"> | ||
| + | # Check if the timeline playback is active. | ||
| + | |||
| + | import RLPy | ||
| + | |||
| + | print(RLPy.RGlobal.IsPlaying()) | ||
| + | |||
| + | # True / False | ||
| + | </syntaxhighlight> | ||
----- | ----- | ||
=== Pause === | === Pause === | ||
Revision as of 19:01, 14 April 2019
Contents
- 1 Detailed Description
- 2 Member Functions
- 2.1 BeginAction
- 2.2 DoPluginTrialFollowUp
- 2.3 DoSNVerification
- 2.4 EndAction
- 2.5 GetEndTime
- 2.6 GetFps
- 2.7 GetMocapManager
- 2.8 GetPath
- 2.9 GetProjectLength
- 2.10 GetStartTime
- 2.11 GetTime
- 2.12 IsPlaying
- 2.13 Pause
- 2.14 Play
- 2.15 RemoveAllAnimations
- 2.16 RenderVideo
- 2.17 SetTime
- 2.18 Stop
- 2.19 TrialVersionRemainingDays
- Main article: Modules.
Detailed Description
This class providing common API global functions.
# 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()
Member Functions
BeginAction
RLPy.RGlobal.BeginAction ( strAction )
Begin action.
Parameters
strAction [IN] action name - string
DoPluginTrialFollowUp
RLPy.RGlobal.DoPluginTrialFollowUp ( strProductNamePath )
Trial Follow up (Internal use)
Parameters
strProductNamePath [IN] Product name path - string
DoSNVerification
RLPy.RGlobal.DoSNVerification ( nProductID, strRegistry, strProductName, strSNFailTitle, strSNFailMsg, strSNExceedTitle, strSNExceedMsg )
Verify serial number.
Parameters
nProductID [IN] product ID - int
strRegistry [IN] registry - string
strProductName [IN] product name - string
strSNFailTitle [IN] fail title - string
strSNFailMsg [IN] fail message - string
strSNExceedTitle [IN] exceed title - string
strSNExceedMsg [IN] exceed message - string
Returns
Remain days of trial version - bool
EndAction
RLPy.RGlobal.EndAction ( )
End action.
GetEndTime
RLPy.RGlobal.GetEndTime ( )
Get end frame time.
Returns
End frame time - RLPy.RTime
GetFps
RLPy.RGlobal.GetFps ( )
Get frame per second.
Returns
Frame rate - int
# Get the project frames per second.
import RLPy
# Get frames per second
print(RLPy.RGlobal.GetFps())
#60
GetMocapManager
RLPy.RGlobal.GetMocapManager ( )
Get mocap manager.
Returns
Pointer to mocap manager - RLPy.RIMocapManager
GetPath
RLPy.RGlobal.GetPath ( ePath, strPath )
Get path.
Parameters
ePath [IN] path type - RLPy.EPathType
- 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
strPath [OUT] path name - string
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
# Print out a few path locations (Individual path locations may vary).
import RLPy
temp = ""
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_Temp, temp)
print("Temp folder: "+ret_list[1])
# Temp folder: C:\Users\User_Name\AppData\Local\Temp\iClone7Temp\iClone7Temp\
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_TemplateContent, temp)
print("Template content folder: "+ret_list[1])
# Template content folder: C:\Users\Public\Documents\Reallusion\Template\iClone 7 Template
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_CustomContent, temp)
print("Custom content folder: "+ret_list[1])
# Custom content folder: C:\Users\Public\Documents\Reallusion\Custom\iClone 7 Custom
ret_list = RLPy.RGlobal.GetPath(RLPy.EPathType_ProgramDefault, temp)
print("Program default folder: "+ret_list[1])
# Program default folder: C:\Program Files\Reallusion\iClone 7\Program\Default\
GetProjectLength
RLPy.RGlobal.GetProjectLength ( )
Get project length.
Returns
Project length - RLPy.RTime
# Retrieve the length of the project in ms.
import RLPy
# Fetch the current frame time in milliseconds.
time = RLPy.RGlobal.GetTime()
# Return the current frame time in milliseconds.
print(time.GetValue())
GetStartTime
RLPy.RGlobal.GetStartTime ( )
Get start frame time.
Returns
Start frame time - RLPy.RTime
GetTime
RLPy.RGlobal.GetTime ( )
Get current frame time.
Returns
Current time - RLPy.RTime
IsPlaying
RLPy.RGlobal.IsPlaying ( )
Is application playing?
Returns
True when application playing - bool
# Check if the timeline playback is active.
import RLPy
print(RLPy.RGlobal.IsPlaying())
# True / False
Pause
RLPy.RGlobal.Pause ( )
Pause the project.
Play
RLPy.RGlobal.Play ( kStart, kEnd )
Play the project.
Parameters
kStart [IN] start time - RLPy.RTime
kEnd [IN] end time - RLPy.RTime
RemoveAllAnimations
RLPy.RGlobal.RemoveAllAnimations ( spObject )
Remove all animations of object. ( Experimental API )
Parameters
spObject [IN] The object to remove animations - RLPy.RIObject
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Remove failed
RenderVideo
RLPy.RGlobal.RenderVideo ( )
Export project into video file. ( Experimental API )
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Remove failed
SetTime
RLPy.RGlobal.SetTime ( kTime )
Set current frame time.
Parameters
kTime [IN] Specifies the time to set - RLPy.RTime
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
Stop
RLPy.RGlobal.Stop ( )
Stop playing.
TrialVersionRemainingDays
RLPy.RGlobal.TrialVersionRemainingDays ( strBinPath, uProductID, strProductFold, strRegRoot )
Get remain days of trial version.
Parameters
strBinPath [IN] bin file path - string
kProductID [IN] product ID
kProductFold [IN] product Folder
kRegRoot [IN] registry root
Returns
Remain days of trial version - int
