IC8 Python API:RLPy RInsertBoneInfo

From Reallusion Wiki!
Jump to: navigation, search

Description

This class stores the names used to insert a bone, including its new name and its parent and child bones.

Constructor & Destructor

__init__ (self)

Initializes a new insert bone info instance.

Member Functions

GetChildBoneName (self)

Returns the child bone name.

Sample code

Demonstrates calls to `RLPy.RInsertBoneInfo.GetChildBoneName`, `RLPy.RInsertBoneInfo.GetNewBoneName`, `RLPy.RInsertBoneInfo.GetParentBoneName`, `RLPy.RInsertBoneInfo.SetInfo`, and `RLPy.RInsertBoneInfo.__eq__` using the example's inputs.

import RLPy

def run_script():
    info = RLPy.RInsertBoneInfo()
    info.SetInfo("Parent", "NewBone", "Child")
    same = RLPy.RInsertBoneInfo()
    same.SetInfo("Parent", "NewBone", "Child")
    different = RLPy.RInsertBoneInfo()
    different.SetInfo("Parent", "OtherBone", "Child")
    return (
        info.GetParentBoneName(),
        info.GetNewBoneName(),
        info.GetChildBoneName(),
        info == same,
        info == different,
    )

GetNewBoneName (self)

Returns the new bone name.

Sample code

Demonstrates calls to `RLPy.RInsertBoneInfo.GetChildBoneName`, `RLPy.RInsertBoneInfo.GetNewBoneName`, `RLPy.RInsertBoneInfo.GetParentBoneName`, `RLPy.RInsertBoneInfo.SetInfo`, and `RLPy.RInsertBoneInfo.__eq__` using the example's inputs.

import RLPy

def run_script():
    info = RLPy.RInsertBoneInfo()
    info.SetInfo("Parent", "NewBone", "Child")
    same = RLPy.RInsertBoneInfo()
    same.SetInfo("Parent", "NewBone", "Child")
    different = RLPy.RInsertBoneInfo()
    different.SetInfo("Parent", "OtherBone", "Child")
    return (
        info.GetParentBoneName(),
        info.GetNewBoneName(),
        info.GetChildBoneName(),
        info == same,
        info == different,
    )

GetParentBoneName (self)

Returns the parent bone name.

Sample code

Demonstrates calls to `RLPy.RInsertBoneInfo.GetChildBoneName`, `RLPy.RInsertBoneInfo.GetNewBoneName`, `RLPy.RInsertBoneInfo.GetParentBoneName`, `RLPy.RInsertBoneInfo.SetInfo`, and `RLPy.RInsertBoneInfo.__eq__` using the example's inputs.

import RLPy

def run_script():
    info = RLPy.RInsertBoneInfo()
    info.SetInfo("Parent", "NewBone", "Child")
    same = RLPy.RInsertBoneInfo()
    same.SetInfo("Parent", "NewBone", "Child")
    different = RLPy.RInsertBoneInfo()
    different.SetInfo("Parent", "OtherBone", "Child")
    return (
        info.GetParentBoneName(),
        info.GetNewBoneName(),
        info.GetChildBoneName(),
        info == same,
        info == different,
    )

SetInfo (self, strParentName, strNewBoneName, strChildName)

Sets the info.

Parameters

  • strParentName
  • strNewBoneName
  • strChildName

Sample code

Demonstrates calls to `RLPy.RInsertBoneInfo.GetChildBoneName`, `RLPy.RInsertBoneInfo.GetNewBoneName`, `RLPy.RInsertBoneInfo.GetParentBoneName`, `RLPy.RInsertBoneInfo.SetInfo`, and `RLPy.RInsertBoneInfo.__eq__` using the example's inputs.

import RLPy

def run_script():
    info = RLPy.RInsertBoneInfo()
    info.SetInfo("Parent", "NewBone", "Child")
    same = RLPy.RInsertBoneInfo()
    same.SetInfo("Parent", "NewBone", "Child")
    different = RLPy.RInsertBoneInfo()
    different.SetInfo("Parent", "OtherBone", "Child")
    return (
        info.GetParentBoneName(),
        info.GetNewBoneName(),
        info.GetChildBoneName(),
        info == same,
        info == different,
    )

__eq__ (self, rhs)

Reports whether this value equals another value.

Parameters

  • rhs

Sample code

Demonstrates calls to `RLPy.RInsertBoneInfo.GetChildBoneName`, `RLPy.RInsertBoneInfo.GetNewBoneName`, `RLPy.RInsertBoneInfo.GetParentBoneName`, `RLPy.RInsertBoneInfo.SetInfo`, and `RLPy.RInsertBoneInfo.__eq__` using the example's inputs.

import RLPy

def run_script():
    info = RLPy.RInsertBoneInfo()
    info.SetInfo("Parent", "NewBone", "Child")
    same = RLPy.RInsertBoneInfo()
    same.SetInfo("Parent", "NewBone", "Child")
    different = RLPy.RInsertBoneInfo()
    different.SetInfo("Parent", "OtherBone", "Child")
    return (
        info.GetParentBoneName(),
        info.GetNewBoneName(),
        info.GetChildBoneName(),
        info == same,
        info == different,
    )

Properties

thisown

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