SBProxy

This class contains a description of the class factory (its constructors) and the class interface (its functions). It used primarily to call functionality exposed from SAMSON extensions thanks to the introspection mechanism.

See also

SAMSON SDK: SBCClassProxy

Introspection: using extensions

class samson.SBProxy

Bases: pybind11_object

This class describes a class proxy.

SAMSON API: Introspection, SBCClassProxy

call(self: samson.SBProxy, object: samson.SBValue, functionName: str, *args) → samson.SBValue

Calls the function functionName for object with the given arguments. You can supply up to 16 SBValue arguments.

constCall(self: samson.SBProxy, object: samson.SBValue, functionName: str, *args) → samson.SBValue

Calls the const function functionName for object with the given arguments. You can supply up to 16 SBValue arguments.

createInstance(self: samson.SBProxy, *args) → samson.SBValue

Create an instance of the class via its proxy and supplies the given arguments args into its constructor. You can provide up to 16 SBValue arguments.

getConstFunction(self: samson.SBProxy, functionName: str, *args) → samson.SBFunction

Returns from the proxy the const function functionName that can accept the given arguments. You can provide up to 16 SBValue arguments.

getFunction(self: samson.SBProxy, functionName: str, *args) → samson.SBFunction

Returns from the proxy the non-const function functionName that can accept the given arguments. You can provide up to 16 SBValue arguments.

hasFunction(self: samson.SBProxy, functionName: str, *args) → bool

Returns whether the proxy has the function functionName that can accept the given arguments. You can provide up to 16 SBValue arguments.

staticCall(self: samson.SBProxy, functionName: str, *args) → samson.SBValue

Calls the static function functionName with the given arguments. You can supply up to 16 SBValue arguments.

property GUIShortcut

Returns the shortcut of the GUI of the class. A read-only property.

property GUIUUID

Returns the UUID of the GUI of the class. A read-only property.

property SDKVersionNumber

Returns the version number of the SAMSON SDK used to compile the class. A read-only property.

property UUID

Returns the UUID of the class. A read-only property.

property description

Returns the description of the class. A read-only property.

property element

Returns the SAMSON Extension containing the class. A read-only property.

property elementUUID

Returns the UUID of the SAMSON Extension containing the class. A read-only property.

property extension

Returns the SAMSON Extension containing the class. A read-only property.

property extensionUUID

Returns the UUID of the SAMSON Extension containing the class. A read-only property.

property iconFileName

Returns the file name of the class icon. A read-only property.

property isDiscoverable

Returns True if can be discovered by the user. A read-only property.

property minimumUserPlan

Returns the minimum user plan required to use this class. A read-only property.

property name

Returns the name of the class. A read-only property.

property publicName

Returns the public name of the class. A read-only property.

property shortcut

Returns the shortcut of the class. A read-only property.

property tooltip

Returns the tooltip of the class. A read-only property.

property type

Returns the type of the class. A read-only property.

property versionNumber

Returns the version number of the class. A read-only property.