IC8 Python API:RLPy RFloatKey

From Reallusion Wiki!
Jump to: navigation, search

Description

This class is used to store and access float data keys. Float keys are managed by RFloatControl via SetValue and GetValue for setting and getting the key value for the corresponding point in time. See Also: RKey, RFloatControl

Constructor & Destructor

__init__ (self, *args)

Initializes a new float key instance.

Parameters

  • args

Member Functions

Clone (self)

Copy the float key data and return as a new float key object.

Sample code

Demonstrates calls to `RLPy.RFloatKey.Clone`, `RLPy.RFloatKey.GetValue`, and `RLPy.RFloatKey.SetValue` using the example's inputs.

import RLPy

def run_script():
    key = RLPy.RFloatKey()
    key.SetValue(7500.0)
    clone = key.Clone()
    return (
        key.GetValue(),
        clone.GetValue(),
        type(clone).__name__,
    )

GetValue (self)

Get the float key value. See Also: SetValue

Sample code

Demonstrates calls to `RLPy.RFloatKey.Clone`, `RLPy.RFloatKey.GetValue`, and `RLPy.RFloatKey.SetValue` using the example's inputs.

import RLPy

def run_script():
    key = RLPy.RFloatKey()
    key.SetValue(7500.0)
    clone = key.Clone()
    return (
        key.GetValue(),
        clone.GetValue(),
        type(clone).__name__,
    )

SetValue (self, fValue)

Set the float key value. See Also: GetValue

Parameters

  • fValue

Sample code

Demonstrates calls to `RLPy.RFloatKey.Clone`, `RLPy.RFloatKey.GetValue`, and `RLPy.RFloatKey.SetValue` using the example's inputs.

import RLPy

def run_script():
    key = RLPy.RFloatKey()
    key.SetValue(7500.0)
    clone = key.Clone()
    return (
        key.GetValue(),
        clone.GetValue(),
        type(clone).__name__,
    )

Properties

thisown

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