Live.Base (runtime)¶
Live 12 — Live Object Model & framework reference (descriptions and signatures).
Functions¶
get_text(...)¶
get_text( (str)classname, (str)textname) -> Text :
Retrieves the (translated) Text identified by classname and textname.
C++ signature :
TText const* get_text(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)
log(...)¶
log( (str)arg1) -> None :
C++ signature :
void log(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)
subst_args(...)¶
subst_args( (Text)text [, (str)arg1='' [, (str)arg2='' [, (str)arg3='' [, (str)arg4='' [, (str)arg5='']]]]]) -> str :
C++ signature :
std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>> subst_args(TText [,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>='' [,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>='' [,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>='' [,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>='' [,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>='']]]]])
Classes¶
class FloatVector(instance)¶
A simple container for returning floats from Live.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (FloatVector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<float, std::__1::allocator<float>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (FloatVector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<float, std::__1::allocator<float>> {lvalue},boost::python::api::object)
class IntU64Vector(instance)¶
A simple container for returning unsigned long integers from Live.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (IntU64Vector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<unsigned long long, std::__1::allocator<unsigned long long>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (IntU64Vector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<unsigned long long, std::__1::allocator<unsigned long long>> {lvalue},boost::python::api::object)
class IntVector(instance)¶
A simple container for returning integers from Live.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (IntVector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<int, std::__1::allocator<int>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (IntVector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<int, std::__1::allocator<int>> {lvalue},boost::python::api::object)
class LimitationError(Exception)¶
Common base class for all non-exit exceptions.
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
add_note(...)¶
Exception.add_note(note) -- add a note to the exception
with_traceback(...)¶
Exception.with_traceback(tb) -- set self.traceback to tb and return self.
Attributes¶
args=<attribute 'args' of 'BaseException' objects>
class ObjectVector(instance)¶
A simple read only container for returning python objects.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (ObjectVector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<boost::python::api::object, std::__1::allocator<boost::python::api::object>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (ObjectVector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<boost::python::api::object, std::__1::allocator<boost::python::api::object>> {lvalue},boost::python::api::object)
class StringVector(instance)¶
A simple container for returning strings from Live.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (StringVector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<TString, std::__1::allocator<TString>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (StringVector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<TString, std::__1::allocator<TString>> {lvalue},boost::python::api::object)
class Text(instance)¶
A translatable, immutable string.
Properties¶
text
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
class Timer(instance)¶
A timer that will trigger a callback after a certain inverval. The timer can be repeated and will trigger the callback every interval. Errors in the callback will stop the timer.
Properties¶
running
Methods¶
__init__(...)¶
init( (object)arg1, (object)callback, (int)interval [, (bool)repeat=False [, (bool)start=False]]) -> None :
C++ signature :
void __init__(_object*,boost::python::api::object,int [,bool=False [,bool=False]])
restart(...)¶
restart( (Timer)arg1) -> None :
C++ signature :
void restart(PythonTimer {lvalue})
start(...)¶
start( (Timer)arg1) -> None :
C++ signature :
void start(PythonTimer {lvalue})
stop(...)¶
stop( (Timer)arg1) -> None :
C++ signature :
void stop(PythonTimer {lvalue})
class Vector(instance)¶
A simple read only container for returning objects from Live.
Methods¶
__init__(...)¶
Raises an exception This class cannot be instantiated from Python
append(...)¶
append( (Vector)arg1, (object)arg2) -> None :
C++ signature :
void append(std::__1::vector<TWeakPtr<TPyHandleBase>, std::__1::allocator<TWeakPtr<TPyHandleBase>>> {lvalue},boost::python::api::object)
extend(...)¶
extend( (Vector)arg1, (object)arg2) -> None :
C++ signature :
void extend(std::__1::vector<TWeakPtr<TPyHandleBase>, std::__1::allocator<TWeakPtr<TPyHandleBase>>> {lvalue},boost::python::api::object)