Builds a MeshModelInstance from a name and a model ID. More...

#include <Rendering/SceneComponents/Models/meshmodelinstancebuilder.h>

Inheritance diagram for MeshModelInstanceBuilder:

Public Member Functions
	MeshModelInstanceBuilder ()

	~MeshModelInstanceBuilder () override

Public Member Functions inherited from MeshModelSource
	MeshModelSource (const QString &modelId="")

	~MeshModelSource () override

QString	getExistingNormalsStateName () const

const QDateTime &	getLastUpdated () const

LockableRef	getLockableReference ()

DataExecution::InputScalar &	getMeshModelInput ()

const DataExecution::InputScalar &	getMeshModelInput () const

MeshModelInterface *	getMeshModelInterface ()

MeshModelInterfaceLockedPtr	getMeshModelInterfaceLocked ()

QString	getModelId ()

const QDateTime &	getModelLastUpdated () const

bool	requestModelUpdate ()

bool	setModelId (const QString &modelId)

Public Member Functions inherited from Operation
	~Operation () override

bool	addInput (Input &input, bool modifiedInPlace=false)

bool	addOutput (Output &output)

template<typename T >
bool	assignInput (const QString &inputName, const T &value)

bool	canSerialize () const override

bool	connectProgressEvents (QProgressBar *progressBar)

virtual Presentation::CustomOperationProperties *	createCustomPropertiesHandler ()

virtual void	ensureHasData ()

bool	getBroadcastUpdateEvents () const

QColor	getColor () const

virtual QString	getDefaultIconPath () const

QString	getDefaultUiPath () const

QString	getDeprecationMessage () const

const QString &	getDescription () const

SerializedItem	getExtras ()

const OperationFactory &	getFactory () const

Operation *	getFromPath (const QString &path, Workspace &relativeTo, QStringList &errors) const override

virtual GraphicsSize	getGraphicsSize () const

virtual QString	getHelpPage () const

QString	getIconPath () const

const QUuid &	getId () const

QString	getIdPath (bool scoped=true) const override

QString	getIdPath (const Workspace &relativeTo) const

difference_type	getIndex (const Input &input, IndexCountingOptions options=SkipNone) const

difference_type	getIndex (const Output &output, IndexCountingOptions options=SkipNone) const

void	getIndexPair (InputScalar &input, difference_type &mainIndex, difference_type &arrayIndex)

Input *	getInput (const QString &name)

const Input *	getInput (const QString &name) const

Input *	getInput (size_type index)

const Input *	getInput (size_type index) const

InputArray *	getInputArray (const QString &name)

const InputArray *	getInputArray (const QString &name) const

IOBaseIteratorRange< Input, false >	getInputs ()

IOBaseIteratorRange< Input, true >	getInputs () const

InputScalar *	getInputScalar (const QString &name)

const InputScalar *	getInputScalar (const QString &name) const

template<typename T >
T &	getInputValue (const QString &inputName)

template<typename T >
const T &	getInputValue (const QString &inputName) const

const QString &	getLabel () const

QString	getLabelRelativeToRoot () const

Output *	getOutput (const QString &name)

const Output *	getOutput (const QString &name) const

Output *	getOutput (size_type index)

const Output *	getOutput (size_type index) const

IOBaseIteratorRange< Output, false >	getOutputs ()

IOBaseIteratorRange< Output, true >	getOutputs () const

template<typename T >
T &	getOutputValue (const QString &outputName)

template<typename T >
const T &	getOutputValue (const QString &outputName) const

bool	getProfilingEnabled () const

int	getProgress () const

int	getProgressContribution () const

bool	getProgressResetByNotUpToDate () const

virtual SchedulerFeatures	getRequiredSchedulerFeatures () const

InputScalar *	getScalarInput (size_type mainIndex, difference_type arrayIndex)

QString	getShortLabel () const

QString	getTagName () const

bool	getTerminateExecution () const

QString	getUiPath () const

bool	getUpToDate () const override

virtual bool	hasRequiredSchedulerFeatures () const

void	idPathChanged () override

virtual bool	inputRebuilt (InputScalar &input)

virtual bool	isAsynchronous () const

virtual bool	isAsynchronousProcess () const

virtual bool	isAtomicUpdate () const

bool	isConnectedToAsynchronous () const override

bool	isDeprecated () const

bool	isEditable () const

bool	isIdPathCachingEnabled () const

virtual bool	isPolymorphicType () const

virtual bool	isRunningAsynchronously () const

virtual bool	isThreadSafe () const

template<typename T >
bool	isType () const

bool	isType (const OperationFactory &type) const

bool	isUpdating () const

virtual bool	isUserConfigurable ()

bool	isUsingDefaultColor () const

bool	isUsingDefaultIconPath () const

bool	isUsingDefaultUiPath () const

bool	isWaitingForAsynchronousUpdate () const override

bool	isWorkspaceType () const

bool	load (const SerializedItem &item) override

void	markUpToDateWhereSafe ()

bool	matchesType (const Operation &otherOperation) const

size_type	numInputs (IndexCountingOptions=SkipNone) const

size_type	numOutputs (IndexCountingOptions=SkipNone) const

bool	removeInput (const QString &name)

bool	removeInput (Input &input)

bool	removeOutput (const QString &name)

bool	removeOutput (Output &output)

virtual void	resetExecutionDependencies ()

bool	save (SerializedItem &item) const override

virtual bool	saveWithData (SerializedItem &item) const

virtual void	setAtomicUpdate (bool atomic)

void	setBroadcastUpdateEvents (bool enable)

void	setColor (const QColor &c)

void	setDescription (const QString &description)

void	setEditable (bool b)

void	setIconPath (const QString &path)

void	setId (const QUuid &id)

virtual void	setIdPathCachingEnabled (bool b)

virtual void	setInputNotUpToDate (InputScalar &input)

virtual void	setIsAsynchronous (bool asynchronous)

virtual void	setIsAsynchronousProcess (bool)

virtual void	setIsRunningAsynchronously (bool asynchronous)

void	setLabel (const QString &label)

virtual void	setOutputNotUpToDate (Output &output)

void	setProfilingEnabled (bool enable)

virtual void	setProgress (int percent)

void	setProgressContribution (int percent)

void	setProgressResetByNotUpToDate (bool b)

virtual void	setRequiredSchedulerFeatures (const SchedulerFeatures &)

void	setTerminateExecution (bool b)

void	setUiPath (const QString &path)

void	setUpToDate (bool b) override

bool	update (Updater *updater=nullptr) override

Public Member Functions inherited from WorkspaceElement
	~WorkspaceElement () override

const Workspace *	getWorkspace () const override

Workspace *	getWorkspace () override

virtual void	workspaceChanged (Workspace *oldWorkspace)

Public Member Functions inherited from Updatable
	~Updatable () override

virtual bool	comesFromExternal () const

QString	getEnclosingScope () const

virtual Updatable *	getFromPath (const QString &path, Workspace &relativeTo, QStringList &errors) const =0

const QString &	getGlobalName () const

virtual QString	getIdPath (bool scoped=true) const =0

virtual Workspace *	getRootWorkspace ()

virtual const Workspace *	getRootWorkspace () const

QString	getScopedGlobalName () const

virtual bool	getUpToDate () const =0

virtual const Workspace *	getWorkspace () const =0

virtual Workspace *	getWorkspace ()=0

virtual void	idPathChanged ()

virtual bool	isConnectedToAsynchronous () const =0

virtual bool	isWaitingForAsynchronousUpdate () const =0

void	setGlobalName (const QString &name)

virtual void	setUpToDate (bool b)=0

virtual bool	update (Updater *updater=nullptr)=0

Public Member Functions inherited from Observable
virtual	~Observable ()

void	attachObserver (Observer &observer)

void	destroy ()

void	detachObserver (Observer &observer)

void	notifyEvent (const ObservableEvent &event)

Public Member Functions inherited from Serialize
virtual	~Serialize ()=default

virtual bool	canSerialize () const =0

virtual bool	load (const SerializedItem &item)=0

virtual bool	save (SerializedItem &item) const =0

Public Member Functions inherited from TextLogger
	TextLogger ()

	TextLogger (const DataExecution::IOBase &io)

	TextLogger (const DataExecution::Operation &operation)

	TextLogger (const TextLogger &logger)

	TextLogger (TextLogger &&logger)

virtual	~TextLogger ()

void	logLine (const Application::LogManager::MessageCategory &category, const QString &msg) const

void	logLine (const QString &msg) const

void	logText (const Application::LogManager::MessageCategory &category, const QString &msg) const

void	logText (const QString &msg) const

TextLogger &	operator= (TextLogger)

Protected Member Functions
bool	bringInputsUpToDate () override

bool	execute () override

bool	finishInputsOutputsAfterLoad (const DataExecution::SerializedItem &item) override

bool	makeOutputsValid () override

Protected Member Functions inherited from MeshModelSource
	MeshModelSource (const DataExecution::OperationFactory &factory, const QString &label, const QString &modelId="", bool createOutput=true)

bool	bringInputsUpToDate () override

bool	bringModelIdUpToDate ()

bool	bringModelUpToDate ()

bool	execute () override

bool	makeOutputsValid () override

void	setInputNotUpToDate (DataExecution::InputScalar &input) override

Protected Member Functions inherited from Operation
	Operation (const OperationFactory &factory, const QString &label)

bool	bringArrayOfInputsUpToDate (Input *&array, size_type arraySize)

bool	bringArrayOfInputsUpToDate (std::vector< Input * > &array)

virtual bool	bringInputsUpToDate ()

bool	bringInputUpToDate (Input &input)

virtual void	cancelExecution (bool b)

virtual bool	execute ()=0

virtual bool	finishInputsOutputsAfterLoad (const SerializedItem &item)

Updater *	getCurrentUpdater ()

virtual const Input *	getRenamedInput (const QString &name) const

virtual const Output *	getRenamedOutput (const QString &name) const

virtual bool	inputsAreUpToDate () const

virtual bool	makeOutputsValid ()

virtual void	markOutputsUpToDate ()

void	pauseUpdate ()

virtual bool	postSave (SerializedItem &item) const

virtual bool	prepareInputsOutputsForLoad (const SerializedItem &item)

void	saveExtras (SerializedItem &item) const

virtual bool	shouldPutInExtras (const QString &tagName) const

Protected Member Functions inherited from WorkspaceElement
	WorkspaceElement ()

Protected Member Functions inherited from Updatable
	Updatable ()

	Updatable (const Updatable &up)

void	notifyUpdated ()

Updatable &	operator= (const Updatable &up)

Protected Member Functions inherited from Observable
	Observable ()

	Observable (const Observable &)

Additional Inherited Members
Public Types inherited from Operation
enum	ConfigStatus { GoodConfig = 0x00 , UnknownConfig = 0x01 , InvalidConfig = 0x02 }

using	difference_type = ptrdiff_t

enum	GraphicsSize { Default = 100 , Small = 65 }
	Options for the graphical size of an operation, able to be changed by derived classes. Values are percentages. More...

enum	IndexCountingOption { SkipNone = 0x0 , SkipInvisible = 0x1 , SkipDependencies = 0x2 }

using	size_type = size_t

Static Public Member Functions inherited from Updatable
static InputScalar *	findInputScalarGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

static IOBase *	findIOBaseGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

static Operation *	findOperationGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

Detailed Description

A MeshModelInstance is used to create an instance of a MeshModel that has already been added to a MeshModelLibrary. This allows geometry information to be reused multiple times in a scene without having to duplicate the data.

Constructor & Destructor Documentation

◆ MeshModelInstanceBuilder()

MeshModelInstanceBuilder ( )

◆ ~MeshModelInstanceBuilder()

~MeshModelInstanceBuilder ( )

override

Member Function Documentation

◆ bringInputsUpToDate()

bool bringInputsUpToDate ( )

overrideprotectedvirtual

This function is responsible for first bringing the dependency input up to date, then determining all the inputs required to update the operation's outputs and bring those inputs up to date as well.

The default implementation assumes all inputs need to be brought up to date, but some operations may only require some of the inputs to be up to date in order to calculate the outputs. Indeed, some of the inputs may need to be up to date, their values checked and then some combination of the rest brought up to date. An example where this could be useful is where an operation should behave differently for different iterations of a loop.

Subclasses which choose to override this function should call the other overloaded version of this function as necessary to actually bring the inputs it needs up to date, since it will handle multi-threading in a future implementation. It must update the dependency input first on its own before anything else.

Returns: True if required inputs were able to be brought up to date.

See also: update(), execute(), bringInputUpToDate(), bringArrayOfInputsUpToDate()

The MeshModelInstanceBuilder override of this function does not try to update the MeshModel input, but it does update the other inputs. The MeshModel input is allowed to remain not up to date until something asks the source to request it by calling requestModelUpdate(). See the MeshModelSource documentation for more details.

Reimplemented from MeshModelSource.

◆ execute()

bool execute ( )

overrideprotectedvirtual

Updates the model input only if something has asked for it via requestModelUpdate(). The source will continue attempting to bring that input up to date once per update until it does so successfully (which usually is the first attempt anyway) or unless something else causes that input to become up to date.

Returns: True if nothing has requested the model input or if the model input was able to be brought up to date (or was up to date already).

Reimplemented from MeshModelSource.

◆ finishInputsOutputsAfterLoad()

bool finishInputsOutputsAfterLoad ( const DataExecution::SerializedItem & item )

overrideprotectedvirtual

Parameters

item	The serialized item that will be loaded.

This function is called just before load() returns (if no errors were encountered during loading). The default implementation simply returns true to indicate that loading completed successfully. Subclasses may override this function to perform any required tasks that must be done after all other loading tasks have completed. Typical uses usually revolve around tasks that rename inputs or outputs, such as setting the data name of data sources or requesters.

Most subclasses will not need to override this function.

Returns: True if the function was successful, false otherwise.

Reimplemented from Operation.

◆ makeOutputsValid()

bool makeOutputsValid ( )

overrideprotectedvirtual

This is an empty operation for MeshModelSource. See the class details for why this is the case. Some comments in Operation::makeOutputsValid() might also be helpful.

Returns: True unconditionally.

Reimplemented from MeshModelSource.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeshModelInstanceBuilder()

◆ ~MeshModelInstanceBuilder()

Member Function Documentation

◆ bringInputsUpToDate()

◆ execute()

◆ finishInputsOutputsAfterLoad()

◆ makeOutputsValid()