IC8 Python API:RLPy RApplication

From Reallusion Wiki!
Jump to: navigation, search

Contents

Main article: iC8 Modules.
Last modified: 10/21/2026

Description

This class provides application-related API.

Static Methods

RLPy.RApplication.GetApiMajorVersion()

Get API major version.

Returns

API major version - int 

1 api_major_version = RLPy.RApplication.GetApiMajorVersion()
2 print(api_major_version)

RLPy.RApplication.GetApiMinorVersion()

Get API minor version.

Returns

API minor version - int 

1 api_minor_version = RLPy.RApplication.GetApiMinorVersion()
2 print(api_minor_version)

RLPy.RApplication.GetApiVersion()

Get the API version.

Returns

API version(major, minor, subversion) - int 

1 api_version = RLPy.RApplication.GetApiVersion()
2 print(api_version)
3 if api_version < (2,0,0):
4     print("API 2.0 is still in development.")

RLPy.RApplication.GetContentFilesInFolder(strFolder)

Get absolute files in the template content folder.

Returns

Absolute files in template content folder - string 

1 # No example

RLPy.RApplication.GetContentFoldersInFolder(strFolder)

Get relative folders in the template content folder.

Returns

Relative folders in template content folder - string 

1 # No example

RLPy.RApplication.GetCustomContentFolder(eFolderType)

Get custom content folder path.

Returns

Custom content folder path - string 

1 # No example

RLPy.RApplication.GetCustomDataPath()

Get the custom data path.

Returns

Custom data path - string 

1 custom_data_path = RLPy.RApplication.GetCustomDataPath()
2 print(custom_data_path)

RLPy.RApplication.GetDefaultContentFolder(eFolderType)

Get the default template content folder relative path.

Returns

Default template content folder relative path - string 

1 # No example

RLPy.RApplication.GetDefaultProjectPath()

Get the default project path.

Returns

Default project path - string 

1 default_project_path = RLPy.RApplication.GetDefaultProjectPath()
2 print(default_project_path)

RLPy.RApplication.GetProductMajorVersion()

Get the product's major version.

Returns

Product major version - int 

1 product_major_version = RLPy.RApplication.GetProductMajorVersion()
2 print(product_major_version)

RLPy.RApplication.GetProductMinorVersion()

Get the product's minor version.

Returns

Product minor version - int 

1 product_minor_version = RLPy.RApplication.GetProductMinorVersion()
2 print(product_minor_version)

RLPy.RApplication.GetProductName()

Get product name.

Returns

Product name - string 

1 product_name = RLPy.RApplication.GetProductName()
2 print(product_name)

RLPy.RApplication.GetProductVersion()

Get the product version.

Returns

Product version(major, minor, subversion) - int 

1 product_version = RLPy.RApplication.GetProductVersion()
2 print(product_version)
3 if product_version < (8,0,0):
4     print("iClone 8 is still in development.")

RLPy.RApplication.GetProgramPath()

Get program path.

Returns

Program path - string 

1 program_path = RLPy.RApplication.GetProgramPath()
2 print(program_path)

RLPy.RApplication.GetTemplateDataPath()

Get template data path.

Returns

Template data path - string 

1 template_data_path = RLPy.RApplication.GetTemplateDataPath()
2 print(template_data_path)

Description

This class provides application-related API.

Constructor & Destructor

__init__ (self)

Initializes a new application instance.

Member Functions

ExecuteSearchByImage (strImagePath)

Execute a content search by image.

Parameters

  • strImagePath

ExecuteSearchByText (strSearchText)

Execute a content search by text.

Parameters

  • strSearchText

GetApiMajorVersion ()

Gets API major version.

GetApiMinorVersion ()

Gets API minor version.

GetApiVersion ()

Gets API version.

GetContentFilesInFolder (strFolder)

Returns the files contained in the specified content folder.

Parameters

  • strFolder

GetContentFoldersInFolder (strFolder)

Returns the folders contained in the specified content folder.

Parameters

  • strFolder

GetContentId (strFilePath)

Gets content ID.

Parameters

  • strFilePath

GetCurrentProjectPath ()

Gets current project path.

GetCustomContentFolder (eFolderType)

Gets custom content folder path.

Parameters

  • eFolderType

GetCustomDataPath ()

Gets custom data path.

GetDefaultContentFolder (eFolderType)

Gets default template content folder relative path.

Parameters

  • eFolderType

GetDefaultProjectPath ()

Gets default project path.

GetFilePathByContentID (strContentID)

Resolve a content ID to a file path.

Parameters

  • strContentID

GetProductEdition ()

Gets product edition.

GetProductMajorVersion ()

Gets product major version.

GetProductMinorVersion ()

Gets product minor version.

GetProductName ()

Gets product name.

GetProductVersion ()

Gets product version.

GetProgramPath ()

Gets program path.

GetSearchPaginationInfo ()

Gets pagination information for the current search context.

GetSearchResultCount ()

Gets the number of results for the current search context.

GetSearchResultSnapshot ()

Gets the current search result snapshot.

GetTemplateDataPath ()

Gets template data path.

SetSearchContext (*args)

Sets the current content manager search context.

Parameters

  • args

SetSearchPage (nPage)

Sets the current search page.

Parameters

  • nPage

WaitForSearchFinish (nTimeoutMs=10000)

Wait for the current content search to finish.

Parameters

  • nTimeoutMs (default: 10000)

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RApplication&oldid=6104"