WrappedStandardExeBuilder Class Reference

Description

Helper to add customisations and default configurations to SCons standard builders.
    The original builder object is wrapped and most calls are simply forwarded to this
    wrapped object by Python magic. But some calls are intercepted in order to inject
    suitable default configuration based on the project setup.

Definition at line 214 of file LumieraEnvironment.py.

Public Member Functions
def	__init__ (self, originalBuilder)
def	__call__ (self, env, target=None, source=None, kw)
def	__nonzero__ (self)
def	buildLocation (self, env, target)
def	installTarget (self, env, buildTarget, kw)
def	invokeOriginalBuilder (self, env, target, source, kw)

Member Function Documentation

__call__()

def __call__	(		self,
			env,
			target = None,
			source = None,
			kw
	)

when the builder gets invoked from the SConscript...
    create a clone environment for specific configuration
    and then pass on the call to the wrapped original builder.
    Automatically define installation targets for build results.
    @note only returning the build targets, not the install targets 

Definition at line 226 of file LumieraEnvironment.py.

References WrappedStandardExeBuilder.buildLocation(), Arguments.get(), TypedArguments< TUP >.get(), TypedArguments< Tuple< ArgType >.get(), PlaybackController.get(), NullValue< Tracker< string >.get(), NullValue< TY >.get(), Config.get(), EngineConfig.get, Tag< TOOL >.get(), P< XX, shared_ptr< long >.get(), P< CHI >.get(), P< PAR >.get(), P< KIND >.get(), P< Asset >.get(), P< Media >.get(), P< Proc >.get(), P< Struct >.get(), P< ErrorLog >.get(), P< Meta >.get(), P< Clip >.get(), P< ProcPatt >.get(), P< Timeline >.get(), P< Pipe >.get(), P< TimeGrid >.get(), P< Sequence >.get(), P< TAR > storedObj storedObj.get(), P< TimeVar >.get(), P< TY >.get(), P< X >.get(), P< XX >.get(), P< XX, P< X >.get(), P< XX, shared_ptr< X >.get(), P< steam::asset::meta::TimeGrid >.get(), P< X, string >.get(), P< string >.get(), P< Dummy< I >.get(), P< TAR > storedObj.get(), P< TAR > o o.get(), P< TAR, BASE >.get(), P< Dummy< 13 > >.get(), P< asset::Sequence >.get(), P< TAR >.get(), P< asset::Timeline >.get(), P< TableEntry >.get(), P< const asset::ProcPatt >.get(), P< ELM >.get(), ModelPortRegistry.get(), BasicSetup.get(), MenuButton.get(), HandlingPattern.get(), LuidH.get(), TypedContext< CX >::ID< TY >.get(), ViewLocator.get(), DB.get(), ReplaceableItem< MEM >.get(), ReplaceableItem< X, COND >.get(), Command.get(), SessionServices< APIS, FRONT, SESS >.get(), Wrapped_Identity< IT >.get(), Column< VAL >.get(), Column< double >.get(), Column< int >.get(), Column< string >.get(), Column< Param >.get(), Wrapped_PickKey< IT >.get(), TSessionServices< IMPS, FRONT, SESS >.get(), TypedCounter.get(), Wrapped_PickVal< IT >.get(), Wrapped_PickConstVal< IT >.get(), ReplaceableItem< X, meta::enable_if< is_assignable_value< X > > >.get(), DataCap.get(), ScopedPtrVect< steam::node::DummyTick >.get(), ScopedPtrVect< Gtk::Widget >.get(), ScopedPtrVect< T >.get(), ScopedPtrVect< node::DummyTick >.get(), ScopedPtrVect< OutputSlot >.get(), ScopedPtrVect< steam::engine::diagn::Block >.get(), ScopedPtrVect< DisplayerSlot >.get(), AllocationCluster::TypeSlot< TY >.get(), ScopedHolder< TY >.get(), ScopedHolder< TI >.get(), ScopedHolder< PoolVec >.get(), InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_SessionCommand, 0), SessionCommand >.get(), InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_DummyPlayer, 0), DummyPlayer >.get(), InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_GuiNotification, 0), GuiNotification >.get(), InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_Gui, 1)>.get(), InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_Display, 0), lumiera::Display >.get(), InstanceHandle< I, FA >.get(), Record< VAL >.get(), InPlaceAnyHolder< siz, AccessPolicy >::Buff< SUB >.get(), VariantO< TYPES, Access >.get(), VariantO< steam::WrapperTypes, util::AccessCasted_O >.get(), SelectVararg< idx >.get(), SelectVararg< i >.get(), SelectVararg< 0 >.get(), SelectOrInit< false, DEFAULT, idx >.get(), InPlaceAnyHolder< siz, InPlaceAnyHolder_useCommonBase< TargetSpec > >.get(), InPlaceAnyHolder< siz, InPlaceAnyHolder_useCommonBase< BA > >.get(), InPlaceAnyHolder< siz, AccessPolicy >.get(), Variant< TYPES >.get(), Variant< DataValues >.get(), DataCap::Locator.get(), BufferMetadata.get(), RecordRef< string >.get(), RecordRef< VAL >.get(), PlantingHandle< BA, DEFAULT >.get(), LumieraExeBuilder.getCustomEnvironment(), LumieraModuleBuilder.getCustomEnvironment(), LumieraPluginBuilder.getCustomEnvironment(), WrappedStandardExeBuilder.installTarget(), and WrappedStandardExeBuilder.invokeOriginalBuilder().

buildLocation()

def buildLocation	(		self,
			env,
			target
	)

prefix project output directory 

Definition at line 243 of file LumieraEnvironment.py.

References LumieraExeBuilder.getBuildDestination(), LumieraModuleBuilder.getBuildDestination(), and LumieraPluginBuilder.getBuildDestination().

Referenced by WrappedStandardExeBuilder.__call__().

Here is the call graph for this function:

Here is the caller graph for this function:

installTarget()

def installTarget	(		self,
			env,
			buildTarget,
			kw
	)

create an additional installation target
    for the generated executable artifact

Definition at line 248 of file LumieraEnvironment.py.

References LumieraExeBuilder.getInstallDestination(), LumieraModuleBuilder.getInstallDestination(), and LumieraPluginBuilder.getInstallDestination().

Referenced by WrappedStandardExeBuilder.__call__().

Here is the call graph for this function:

Here is the caller graph for this function:

Inheritance diagram for WrappedStandardExeBuilder:

Collaboration diagram for WrappedStandardExeBuilder:

---

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

• LumieraEnvironment.py