Fragment is the base computation unit in the view system. More...

#include <Fragment.h>

Inheritance diagram for Fragment:

Public Member Functions
FragmentGraphAPI	Fragment ()
	Constructor. More...

virtual FragmentGraphAPI	~Fragment ()
	Destructor. More...

FragmentGraphAPI bool	Evaluate (void *evaluationContext)
	Evaluates this fragment. More...

FragmentGraphAPI bool	ReEvaluate (void *evaluationContext)
	Re-evaluates this fragment. More...

FragmentGraphAPI size_t	GetNumberOfInputs () const
	Gets the number of inputs for this fragment. More...

FragmentGraphAPI Input &	GetInput (size_t inputIndex)
	Gets the n-th input for this fragment. More...

FragmentGraphAPI const Input &	GetInput (size_t inputIndex) const
	Gets the n-th input for this fragment. More...

FragmentGraphAPI const Variable *	GetInputVariable (size_t inputIndex) const
	Gets the n-th input variable for this fragment. More...

FragmentGraphAPI Output *	GetInputSource (size_t inputIndex) const
	Gets the output of another fragment that is connected to n-th input for this fragment. More...

FragmentGraphAPI bool	SetInputSource (size_t inputIndex, Output *pOutput)
	Connects the input to an output. More...

FragmentGraphAPI size_t	GetNumberOfOutputs () const
	Gets the number of outputs for this fragment. More...

FragmentGraphAPI Output &	GetOutput (size_t outputIndex)
	Gets the n-th output for this fragment. More...

FragmentGraphAPI const Output &	GetOutput (size_t outputIndex) const
	Gets the n-th output for this fragment. More...

FragmentGraphAPI bool	SetOutputVariable (size_t outputIndex, const Variable &var)
	Updates the value of the n-th output. More...

FragmentGraphAPI bool	GetFlag (FragmentFlags flag) const
	Gets a flag for this fragment. More...

FragmentGraphAPI void	SetFlag (FragmentFlags flag, bool onOff)
	Sets a flag for this fragment. More...

FragmentGraphAPI void	SetParent (Fragment *pParent)
	Assigns the parent fragment. More...

FragmentGraphAPI Fragment *	GetParent () const
	Gets the parent fragment. More...

FragmentGraphAPI IVariableDictionary *	GetParameterTable ()
	Gets the container of all built-in parameters. More...

FragmentGraphAPI const IVariableDictionary *	GetParameterTable () const
	Gets the container of all built-in parameters. More...

virtual FragmentGraphAPI bool	OnMessage (const FragmentMessageParameter &param)
	The fragment message handling callback function that is called if any of its registered messages (including the timer message) is invoked. More...

FragmentGraphAPI void	SetTimerTicks (size_t timerTicks)
	Registers or deregisters the timer message and set the timer ticks value in milliseconds. More...

FragmentGraphAPI size_t	GetTimerTicks () const
	Gets the timer ticks value in milliseconds. More...

FragmentGraphAPI void	RegisterMessage (size_t messageID)
	Register a message with this fragment. More...

FragmentGraphAPI bool	UnRegisterMessage (size_t messageID)
	Deregister a message with this fragment. More...

FragmentGraphAPI const Tab< size_t > &	GetRegisteredMessageIDs () const
	Gets all the messages that have been registered. More...

virtual FragmentGraphAPI Class_ID	GetClassID () const
	Gets the class ID of this fragment. More...

Public Member Functions inherited from ARefObject
GraphicsUtilityAPI	ARefObject ()

virtual GraphicsUtilityAPI long	AddRef ()
	from IRefObject, see comments in IRefObject More...

virtual GraphicsUtilityAPI long	Release ()
	decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted. More...

GraphicsUtilityAPI IRefObject *	QueryInterface (Interface_ID classID)
	Try query an interface from the ref object using a given interface id. More...

Public Member Functions inherited from IRefObject
GraphicsUtilityAPI	IRefObject ()

virtual GraphicsUtilityAPI	~IRefObject ()

Protected Member Functions
FragmentGraphAPI bool	InitializeInputs (const Class_ID &type1)
	Initializes the inputs for the fragment. More...

FragmentGraphAPI bool	InitializeInputs (const Class_ID &type1, const Class_ID &type2)
	Initializes the inputs for the fragment. More...

FragmentGraphAPI bool	InitializeInputs (const Class_ID &type1, const Class_ID &type2, const Class_ID &type3)
	Initializes the inputs for the fragment. More...

FragmentGraphAPI bool	InitializeInputs (const Class_ID &type1, const Class_ID &type2, const Class_ID &type3, const Class_ID &type4)
	Initializes the inputs for the fragment. More...

FragmentGraphAPI bool	InitializeInputs (size_t numberOfInputs, const Class_ID *pInputTypes)
	Initializes the inputs for the fragment. More...

FragmentGraphAPI bool	InitializeOutputs (const Class_ID &type1)
	Initializes the outputs for the fragment. More...

FragmentGraphAPI bool	InitializeOutputs (const Class_ID &type1, const Class_ID &type2)
	Initializes the outputs for the fragment. More...

FragmentGraphAPI bool	InitializeOutputs (const Class_ID &type1, const Class_ID &type2, const Class_ID &type3)
	Initializes the outputs for the fragment. More...

FragmentGraphAPI bool	InitializeOutputs (const Class_ID &type1, const Class_ID &type2, const Class_ID &type3, const Class_ID &type4)
	Initializes the outputs for the fragment. More...

FragmentGraphAPI bool	InitializeOutputs (size_t numberOfOutputs, const Class_ID *pOutputTypes)
	Initializes the outputs for the fragment. More...

virtual FragmentGraphAPI Input *	CreateInput (const Class_ID &typeID)
	Create an input instance of this fragment. More...

virtual FragmentGraphAPI Output *	CreateOutput (const Class_ID &typeID)
	Create an output instance of this fragment. More...

virtual FragmentGraphAPI void	HandleFlagChanged (FragmentFlags flag, bool oldValue)
	This function will be invoked when any fragment flag gets changed. More...

virtual FragmentGraphAPI void	HandleSubFragmentFlagChanged (Fragment *pSubFragment, FragmentFlags flag, bool oldValue)
	This function will be invoked when any fragment flag of a sub fragment gets changed. More...

virtual bool	DoEvaluate (void *evaluationContext)=0
	Do evaluation. More...

Protected Member Functions inherited from ARefObject
virtual GraphicsUtilityAPI void	DeleteThis ()
	This function will be called when the reference count of an ARefObject equals zero. More...

virtual GraphicsUtilityAPI	~ARefObject ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

Fragment is the base computation unit in the view system.

A fragment has multiple inputs and outputs. Fragments can be connected together as a compute graph via those inputs and outputs. In this way, very complicated view features can be achieved, for example, combining the mental-ray GI pass with the Nitrous gizmo pass.

Constructor & Destructor Documentation

◆ Fragment()

FragmentGraphAPI Fragment ( )

Constructor.

◆ ~Fragment()

virtual FragmentGraphAPI ~Fragment ( )

virtual

Destructor.

Member Function Documentation

◆ InitializeInputs() [1/5]

FragmentGraphAPI bool InitializeInputs ( const Class_ID & type1 )

protected

Initializes the inputs for the fragment.

The inputs can only be initialized once for each fragment. Once the inputs are initialized, developers cannot change any of the inputs at runtime. This function will initialize the fragment to one input with the given type.

Parameters

[in] type1 type of the first input.

Returns: true on success, false otherwise.

◆ InitializeInputs() [2/5]

FragmentGraphAPI bool InitializeInputs	(	const Class_ID &	type1,
		const Class_ID &	type2
	)

protected

Initializes the inputs for the fragment.

The inputs can only be initialized once for each fragment. Once the inputs are initialized, developers cannot change any of the inputs at runtime. This function will initialize the fragment to two inputs with the given types.

Parameters

[in]	type1	type of the first input.
[in]	type2	type of the second input.

Returns: true on success, false otherwise.

◆ InitializeInputs() [3/5]

FragmentGraphAPI bool InitializeInputs	(	const Class_ID &	type1,
		const Class_ID &	type2,
		const Class_ID &	type3
	)

protected

Initializes the inputs for the fragment.

The inputs can only be initialized once for each fragment. Once the inputs are initialized, developers cannot change any of the inputs at runtime. This function will initialize the fragment to three inputs with the given types.

Parameters

[in]	type1	type of the first input.
[in]	type2	type of the second input.
[in]	type3	type of the third input.

Returns: true on success, false otherwise.

◆ InitializeInputs() [4/5]

FragmentGraphAPI bool InitializeInputs	(	const Class_ID &	type1,
		const Class_ID &	type2,
		const Class_ID &	type3,
		const Class_ID &	type4
	)

protected

Initializes the inputs for the fragment.

The inputs can only be initialized once for each fragment. Once the inputs are initialized, developers cannot change any of the inputs at runtime. This function will initialize the fragment to four inputs with the given types.

Parameters

[in]	type1	type of the first input.
[in]	type2	type of the second input.
[in]	type3	type of the third input.
[in]	type4	type of the forth input.

Returns: true on success, false otherwise.

◆ InitializeInputs() [5/5]

FragmentGraphAPI bool InitializeInputs	(	size_t	numberOfInputs,
		const Class_ID *	pInputTypes
	)

protected

Initializes the inputs for the fragment.

The inputs can only be initialized once for each fragment. Once the inputs are initialized, developers cannot change any of the inputs at runtime. This function will initialize the fragment to n input with the given types.

Parameters

[in]	numberOfInputs	the number of inputs for this fragment.
[in]	pInputTypes	pointer to an array of the input types. This array must be the same size as numberOfInputs.

Returns: true on success, false otherwise.

◆ InitializeOutputs() [1/5]

FragmentGraphAPI bool InitializeOutputs ( const Class_ID & type1 )

protected

Initializes the outputs for the fragment.

The outputs can only be initialized once for each fragment. Once the outputs are initialized, developers cannot change any of the outputs at runtime. This function will initialize the fragment to one output with the given type.

Parameters

[in] type1 type of the first output.

Returns: true on success, false otherwise.

◆ InitializeOutputs() [2/5]

FragmentGraphAPI bool InitializeOutputs	(	const Class_ID &	type1,
		const Class_ID &	type2
	)

protected

Initializes the outputs for the fragment.

The outputs can only be initialized once for each fragment. Once the outputs are initialized, developers cannot change any of the outputs at runtime. This function will initialize the fragment to two outputs with the given types.

Parameters

[in]	type1	type of the first output.
[in]	type2	type of the second output.

Returns: true on success, false otherwise.

◆ InitializeOutputs() [3/5]

FragmentGraphAPI bool InitializeOutputs	(	const Class_ID &	type1,
		const Class_ID &	type2,
		const Class_ID &	type3
	)

protected

Initializes the outputs for the fragment.

The outputs can only be initialized once for each fragment. Once the outputs are initialized, developers cannot change any of the outputs at runtime. This function will initialize the fragment to three outputs with the given types.

Parameters

[in]	type1	type of the first output.
[in]	type2	type of the second output.
[in]	type3	type of the third output.

Returns: true on success, false otherwise.

◆ InitializeOutputs() [4/5]

FragmentGraphAPI bool InitializeOutputs	(	const Class_ID &	type1,
		const Class_ID &	type2,
		const Class_ID &	type3,
		const Class_ID &	type4
	)

protected

Initializes the outputs for the fragment.

The outputs can only be initialized once for each fragment. Once the outputs are initialized, developers cannot change any of the outputs at runtime. This function will initialize the fragment to four outputs with the given types.

Parameters

[in]	type1	type of the first output.
[in]	type2	type of the second output.
[in]	type3	type of the third output.
[in]	type4	type of the forth output.

Returns: true on success, false otherwise.

◆ InitializeOutputs() [5/5]

FragmentGraphAPI bool InitializeOutputs	(	size_t	numberOfOutputs,
		const Class_ID *	pOutputTypes
	)

protected

Initializes the outputs for the fragment.

The outputs can only be initialized once for each fragment. Once the outputs are initialized, developers cannot change any of the outputs at runtime. This function will initialize the fragment to n outputs with the given types.

Parameters

[in]	numberOfOutputs	the number of outputs for this fragment.
[in]	pOutputTypes	pointer to an array of the output types. This array must be the same size as numberOfOutputs.

Returns: true on success, false otherwise.

◆ CreateInput()

virtual FragmentGraphAPI Input* CreateInput ( const Class_ID & typeID )

protectedvirtual

Create an input instance of this fragment.

This function is called by InitializeInputs() when initializing inputs. This function could be overridden if a fragment would like to customize its own implementation of fragment inputs.

Parameters

[in] typeID type of the input

Returns: the input object corresponding to typeID.

Reimplemented in FragmentGraph.

◆ CreateOutput()

virtual FragmentGraphAPI Output* CreateOutput ( const Class_ID & typeID )

protectedvirtual

Create an output instance of this fragment.

This function is called by InitializeOutputs() when initializing outputs. This function could be overridden if a fragment would like to customize its own implementation of fragment inputs.

Parameters

[in] typeID type of the output

Returns: the output object corresponding to typeID.

Reimplemented in FragmentGraph.

◆ HandleFlagChanged()

virtual FragmentGraphAPI void HandleFlagChanged	(	FragmentFlags	flag,
		bool	oldValue
	)

protectedvirtual

This function will be invoked when any fragment flag gets changed.

Parameters

[in]	flag	the flag that gets changed
[in]	oldValue	the old value of the flag

Reimplemented in FragmentGraph.

◆ HandleSubFragmentFlagChanged()

virtual FragmentGraphAPI void HandleSubFragmentFlagChanged	(	Fragment *	pSubFragment,
		FragmentFlags	flag,
		bool	oldValue
	)

protectedvirtual

This function will be invoked when any fragment flag of a sub fragment gets changed.

Parameters

[in]	pSubFragment	the sub fragment whose flag gets changed
[in]	flag	the flag that gets changed
[in]	oldValue	the old value of the flag

◆ DoEvaluate()

virtual bool DoEvaluate ( void * evaluationContext )

protectedpure virtual

Do evaluation.

A concrete fragment class must override this function, perform necessary computation in this function, and set value to its output. Please note this function cannot be directly called, it can only be called indirectly by calling Fragment::Evaluate().

Parameters

[in] evaluationContext context info for evaluation.

Returns: true on success, false otherwise.

Implemented in FragmentGraph.

◆ Evaluate()

FragmentGraphAPI bool Evaluate ( void * evaluationContext )

Evaluates this fragment.

Updates the output values.

Parameters

[in] evaluationContext context info for evaluation.

Returns: true on success, false otherwise.

◆ ReEvaluate()

FragmentGraphAPI bool ReEvaluate ( void * evaluationContext )

Re-evaluates this fragment.

We will first clear the FragmentFlagsEvaluated flag and then Call Evaluate().

Parameters

[in] evaluationContext context info for evaluation.

Returns: true on success, false otherwise.

◆ GetNumberOfInputs()

FragmentGraphAPI size_t GetNumberOfInputs ( ) const

Gets the number of inputs for this fragment.

Returns: the number of inputs of this fragment.

◆ GetInput() [1/2]

FragmentGraphAPI Input& GetInput ( size_t inputIndex )

Gets the n-th input for this fragment.

Parameters

[in] inputIndex the index of the input.

Returns: the n-th input for this fragment.

◆ GetInput() [2/2]

FragmentGraphAPI const Input& GetInput ( size_t inputIndex ) const

Gets the n-th input for this fragment.

Parameters

[in] inputIndex the index of the input.

Returns: the n-th input for this fragment.

◆ GetInputVariable()

FragmentGraphAPI const Variable* GetInputVariable ( size_t inputIndex ) const

Gets the n-th input variable for this fragment.

Parameters

[in] inputIndex the index of the input.

Returns: if the given input is connected to an output, this function returns the variable from that output. Otherwise, this function returns NULL.

◆ GetInputSource()

FragmentGraphAPI Output* GetInputSource ( size_t inputIndex ) const

Gets the output of another fragment that is connected to n-th input for this fragment.

Parameters

[in] inputIndex the index of the input.

Returns: if the given input is connected to an output, this function returns that output. Otherwise, this function returns NULL.

◆ SetInputSource()

FragmentGraphAPI bool SetInputSource	(	size_t	inputIndex,
		Output *	pOutput
	)

Connects the input to an output.

Parameters

[in]	inputIndex	the index of the input.
[in]	pOutput	the pointer to an output of another fragment. Please note the fragment system doesn't accept circular connections. (i.e. A is connected to B, B is connected to C, while C is connected to A).

Returns: true if connected, false otherwise.

◆ GetNumberOfOutputs()

FragmentGraphAPI size_t GetNumberOfOutputs ( ) const

Gets the number of outputs for this fragment.

Returns: the number of outputs of this fragment.

◆ GetOutput() [1/2]

FragmentGraphAPI Output& GetOutput ( size_t outputIndex )

Gets the n-th output for this fragment.

Parameters

[in] outputIndex the index of the output.

Returns: the n-th output for this fragment.

◆ GetOutput() [2/2]

FragmentGraphAPI const Output& GetOutput ( size_t outputIndex ) const

Gets the n-th output for this fragment.

Parameters

[in] outputIndex the index of the output.

Returns: the n-th output for this fragment.

◆ SetOutputVariable()

FragmentGraphAPI bool SetOutputVariable	(	size_t	outputIndex,
		const Variable &	var
	)

Updates the value of the n-th output.

Parameters

[in]	outputIndex	the index of the output.
[in]	var	the value to update.

Returns: true if updated successfully, false otherwise.

◆ GetFlag()

FragmentGraphAPI bool GetFlag ( FragmentFlags flag ) const

Gets a flag for this fragment.

Parameters

[in] flag the flag bit to query

Returns: true if this flag is on, false otherwise.

◆ SetFlag()

FragmentGraphAPI void SetFlag	(	FragmentFlags	flag,
		bool	onOff
	)

Sets a flag for this fragment.

Parameters

[in]	flag	the flag bit to set
[in]	onOff	the value for the flag bit.

◆ SetParent()

FragmentGraphAPI void SetParent ( Fragment * pParent )

Assigns the parent fragment.

This function will be invoked when a fragment node is added to a fragment graph.

Parameters

[in] pParent the parent of this fragment

◆ GetParent()

FragmentGraphAPI Fragment* GetParent ( ) const

Gets the parent fragment.

Returns: the parent fragment.

◆ GetParameterTable() [1/2]

FragmentGraphAPI IVariableDictionary* GetParameterTable ( )

Gets the container of all built-in parameters.

Returns: the container of all built-in parameters.

◆ GetParameterTable() [2/2]

FragmentGraphAPI const IVariableDictionary* GetParameterTable ( ) const

Gets the container of all built-in parameters.

Returns: the container of all built-in parameters.

◆ OnMessage()

virtual FragmentGraphAPI bool OnMessage ( const FragmentMessageParameter & param )

virtual

The fragment message handling callback function that is called if any of its registered messages (including the timer message) is invoked.

Parameters

[in] param The message id and parameters of the message that has been invoked.

◆ SetTimerTicks()

FragmentGraphAPI void SetTimerTicks ( size_t timerTicks )

Registers or deregisters the timer message and set the timer ticks value in milliseconds.

To deregister this timer, assign TIMER_NONE to timerTicks.

Parameters

[in] timerTicks the timer ticks value

◆ GetTimerTicks()

FragmentGraphAPI size_t GetTimerTicks ( ) const

Gets the timer ticks value in milliseconds.

Returns: the timer ticks value if a timer is registered or TIMER_NONE otherwise.

◆ RegisterMessage()

FragmentGraphAPI void RegisterMessage ( size_t messageID )

Register a message with this fragment.

Parameters

[in] messageID the id of the message to register

◆ UnRegisterMessage()

FragmentGraphAPI bool UnRegisterMessage ( size_t messageID )

Deregister a message with this fragment.

Parameters

[in] messageID the id of the message to deregister

◆ GetRegisteredMessageIDs()

FragmentGraphAPI const Tab<size_t>& GetRegisteredMessageIDs ( ) const

Gets all the messages that have been registered.

Returns: all messages that have been registered.

◆ GetClassID()

virtual FragmentGraphAPI Class_ID GetClassID ( ) const

virtual

Gets the class ID of this fragment.

Returns: the class ID of this fragment.

Reimplemented in FragmentGraph.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Fragment()

◆ ~Fragment()

Member Function Documentation

◆ InitializeInputs() [1/5]

◆ InitializeInputs() [2/5]

◆ InitializeInputs() [3/5]

◆ InitializeInputs() [4/5]

◆ InitializeInputs() [5/5]

◆ InitializeOutputs() [1/5]

◆ InitializeOutputs() [2/5]

◆ InitializeOutputs() [3/5]

◆ InitializeOutputs() [4/5]

◆ InitializeOutputs() [5/5]

◆ CreateInput()

◆ CreateOutput()

◆ HandleFlagChanged()

◆ HandleSubFragmentFlagChanged()

◆ DoEvaluate()

◆ Evaluate()

◆ ReEvaluate()

◆ GetNumberOfInputs()

◆ GetInput() [1/2]

◆ GetInput() [2/2]

◆ GetInputVariable()

◆ GetInputSource()

◆ SetInputSource()

◆ GetNumberOfOutputs()

◆ GetOutput() [1/2]

◆ GetOutput() [2/2]

◆ SetOutputVariable()

◆ GetFlag()

◆ SetFlag()

◆ SetParent()

◆ GetParent()

◆ GetParameterTable() [1/2]

◆ GetParameterTable() [2/2]

◆ OnMessage()

◆ SetTimerTicks()

◆ GetTimerTicks()

◆ RegisterMessage()

◆ UnRegisterMessage()

◆ GetRegisteredMessageIDs()

◆ GetClassID()