GL Studio C++ Runtime API
LiveComponentAccessor Class Reference

#include <live_component_accessor.h>

Public Types

typedef void(* CreateCb) (ComponentBase *)
 Typedef for an on create callback function pointer.
 

Public Member Functions

virtual LiveComponentAccessor * Clone (ComponentBase *newComp)
 
virtual void Delete ()
 Deletes the LiveComponentAccessor, it's associated component, and the LiveComponentLibRef.
 
const GlsBuiltVersionInfo & BuiltVersion ()
 
const char * LoadedFilePath ()
 
const char * LoadedClassName ()
 

Static Public Member Functions

static LiveComponentAccessor * CreateInstance (LiveComponentLibRef *lib, const char *className, ComponentBase *comp)
 

Detailed Description

LiveComponentAccessor keeps the LiveComponent library loaded in the application. and stores the information necessary to safely delete the component.

Member Function Documentation

◆ BuiltVersion()

const GlsBuiltVersionInfo & BuiltVersion ( )
Returns
The RSO library version info.

◆ Clone()

virtual LiveComponentAccessor * Clone ( ComponentBase *  newComp)
virtual

Clone the LiveComponentAccessor to apply to a new component instance.

Parameters
newCompThe component reference to make a clone from.
Returns
A new LiveComponentAccessor object.

◆ CreateInstance()

static LiveComponentAccessor * CreateInstance ( LiveComponentLibRef *  lib,
const char *  className,
ComponentBase *  comp 
)
static

Creates a LiveComponentAccessor and associates it with the given component.

Parameters
libPointer to the underlying library the component was loaded from.
classNameThe generated class name for the component.
compPointer to the component reference.
Returns
A new LiveComponentAccessor object.

◆ LoadedClassName()

const char * LoadedClassName ( )
Returns
The RSO's class name.

◆ LoadedFilePath()

const char * LoadedFilePath ( )
Returns
The RSO library path.

The documentation for this class was generated from the following file: