Variable is a simple class that stores certain data that a developer can decide at runtime. More...

#include <Variable.h>

Inheritance diagram for Variable:

Public Member Functions
FragmentGraphAPI	Variable ()
	Default constructor. More...

FragmentGraphAPI	Variable (char iValue)
	Constructs a char-type variable with the given value. More...

FragmentGraphAPI	Variable (unsigned char iValue)
	Constructs an unsigned char variable with the given value. More...

FragmentGraphAPI	Variable (wchar_t iValue)
	Constructs a wchar_t variable with the given value. More...

FragmentGraphAPI	Variable (short iValue)
	Constructs a short variable with the given value. More...

FragmentGraphAPI	Variable (unsigned short iValue)
	Constructs an unsigned short variable with the given value. More...

FragmentGraphAPI	Variable (int iValue)
	Constructs an int variable with the given value. More...

FragmentGraphAPI	Variable (unsigned int iValue)
	Constructs an unsigned int variable with the given value. More...

FragmentGraphAPI	Variable (long iValue)
	Constructs a long variable with the given value. More...

FragmentGraphAPI	Variable (unsigned long iValue)
	Constructs an unsigned long variable with the given value. More...

FragmentGraphAPI	Variable (__int64 iValue)
	Constructs a __int64 variable with the given value. More...

FragmentGraphAPI	Variable (unsigned __int64 iValue)
	Constructs an unsigned __int64 variable with the given value. More...

FragmentGraphAPI	Variable (float fValue)
	Constructs a float variable with the given value. More...

FragmentGraphAPI	Variable (double fValue)
	Constructs a double variable with the given value. More...

FragmentGraphAPI	Variable (const char *str)
	Constructs a multi-byte string variable with the given value. More...

FragmentGraphAPI	Variable (const wchar_t *str)
	Constructs a Unicode string variable with the given value. More...

FragmentGraphAPI	Variable (MaxSDK::Graphics::IRefObject *pRefObject)
	Constructs an IRefObject auto-ptr variable with the given value. More...

FragmentGraphAPI	Variable (const Variable &from)
	Copy constructor. More...

FragmentGraphAPI	~Variable ()
	Destructor. More...

FragmentGraphAPI void	ChangeType (VarType type)
	Changes this variable to a certain type, and resets the value. More...

VarType	GetType () const
	Gets the type of this variable. More...

FragmentGraphAPI char	AsChar () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI unsigned char	AsUnsignedChar () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI wchar_t	AsWideChar () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI short	AsShort () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI unsigned short	AsUnsignedShort () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI int	AsInt () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI unsigned int	AsUnsignedInt () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI long	AsLong () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI unsigned long	AsUnsignedLong () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI __int64	AsInt64 () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI unsigned __int64	AsUnsignedInt64 () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI float	AsFloat () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI double	AsDouble () const
	Tries to convert this variable to char and return the value. More...

FragmentGraphAPI const char *	AsStringA () const
	Tries to get the multi-byte string value of this variable. More...

FragmentGraphAPI const wchar_t *	AsStringW () const
	Tries to get the Unicode string value of this variable. More...

FragmentGraphAPI MaxSDK::Graphics::IRefObject *	AsRefObject () const
	Tries to get the IRefObject pointer that is referenced by this variable. More...

FragmentGraphAPI IVariableDictionary *	AsDictionary () const
	Tries to get the dictionary pointer that is referenced by this variable. More...

FragmentGraphAPI bool	TryUpdateValue (char iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (unsigned char iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (wchar_t iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (short iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (unsigned short iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (int iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (unsigned int iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (long iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (unsigned long iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (__int64 iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (unsigned __int64 iValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (float fValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (double fValue)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (const char *str)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (const wchar_t *str)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (MaxSDK::Graphics::IRefObject *pRefObject)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI bool	TryUpdateValue (const Variable &var)
	Tries to update this variable's value, without changing this variable's type. More...

FragmentGraphAPI Variable &	operator= (char rhs)
	Converts this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (unsigned char rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (wchar_t rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (short rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (unsigned short rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (int rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (unsigned int rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (long rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (unsigned long rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (__int64 rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (unsigned __int64 rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (float rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (double rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (const char *rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (const wchar_t *rhs)
	convert this variable to the input value type. More...

FragmentGraphAPI Variable &	operator= (MaxSDK::Graphics::IRefObject *rhs)
	convert this variable to the input value type, then assigns the input value to this variable. More...

FragmentGraphAPI Variable &	operator= (const Variable &var)
	convert this variable to the input value type, then assigns the input value to this variable. More...

Static Public Member Functions
static FragmentGraphAPI size_t	GetNetStringCount ()

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

Variable is a simple class that stores certain data that a developer can decide at runtime.

We use this class to transfer parameters from fragment to fragment.

Constructor & Destructor Documentation

◆ Variable() [1/18]

FragmentGraphAPI Variable ( )

Default constructor.

The default type of the variable is int and the default value is zero.

◆ Variable() [2/18]

FragmentGraphAPI Variable ( char iValue )

Constructs a char-type variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [3/18]

FragmentGraphAPI Variable ( unsigned char iValue )

Constructs an unsigned char variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [4/18]

FragmentGraphAPI Variable ( wchar_t iValue )

Constructs a wchar_t variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [5/18]

FragmentGraphAPI Variable ( short iValue )

Constructs a short variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [6/18]

FragmentGraphAPI Variable ( unsigned short iValue )

Constructs an unsigned short variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [7/18]

FragmentGraphAPI Variable ( int iValue )

Constructs an int variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [8/18]

FragmentGraphAPI Variable ( unsigned int iValue )

Constructs an unsigned int variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [9/18]

FragmentGraphAPI Variable ( long iValue )

Constructs a long variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [10/18]

FragmentGraphAPI Variable ( unsigned long iValue )

Constructs an unsigned long variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [11/18]

FragmentGraphAPI Variable ( __int64 iValue )

Constructs a __int64 variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [12/18]

FragmentGraphAPI Variable ( unsigned __int64 iValue )

Constructs an unsigned __int64 variable with the given value.

Parameters

[in] iValue The initial value of this variable.

◆ Variable() [13/18]

FragmentGraphAPI Variable ( float fValue )

Constructs a float variable with the given value.

Parameters

[in] fValue The initial value of this variable.

◆ Variable() [14/18]

FragmentGraphAPI Variable ( double fValue )

Constructs a double variable with the given value.

Parameters

[in] fValue The initial value of this variable.

◆ Variable() [15/18]

FragmentGraphAPI Variable ( const char * str )

Constructs a multi-byte string variable with the given value.

Parameters

[in] str The initial value of this variable. Cannot be NULL.

◆ Variable() [16/18]

FragmentGraphAPI Variable ( const wchar_t * str )

Constructs a Unicode string variable with the given value.

Parameters

[in] str The initial value of this variable. Cannot be NULL.

◆ Variable() [17/18]

FragmentGraphAPI Variable ( MaxSDK::Graphics::IRefObject * pRefObject )

Constructs an IRefObject auto-ptr variable with the given value.

Parameters

[in] pRefObject The initial value of this variable. Can be NULL.

◆ Variable() [18/18]

FragmentGraphAPI Variable ( const Variable & from )

Copy constructor.

Parameters

[in] from The default value of this variable.

◆ ~Variable()

FragmentGraphAPI ~Variable ( )

Destructor.

Member Function Documentation

◆ GetNetStringCount()

static FragmentGraphAPI size_t GetNetStringCount ( )

static

◆ ChangeType()

FragmentGraphAPI void ChangeType ( VarType type )

Changes this variable to a certain type, and resets the value.

For numbers, resets to zero. For string, resets to empty string. For RefObject, resets to NULL.

Parameters

[in] type The type that this variable will be changed to.

◆ GetType()

VarType GetType ( ) const

inline

Gets the type of this variable.

Returns: the type of this variable.

         {
             return mType;
         }

◆ AsChar()

FragmentGraphAPI char AsChar ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A char value.

◆ AsUnsignedChar()

FragmentGraphAPI unsigned char AsUnsignedChar ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An unsigned char value.

◆ AsWideChar()

FragmentGraphAPI wchar_t AsWideChar ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A wchar_t value.

◆ AsShort()

FragmentGraphAPI short AsShort ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A short value.

◆ AsUnsignedShort()

FragmentGraphAPI unsigned short AsUnsignedShort ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An unsigned short value.

◆ AsInt()

FragmentGraphAPI int AsInt ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An int value.

◆ AsUnsignedInt()

FragmentGraphAPI unsigned int AsUnsignedInt ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An unsigned int value.

◆ AsLong()

FragmentGraphAPI long AsLong ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A long value.

◆ AsUnsignedLong()

FragmentGraphAPI unsigned long AsUnsignedLong ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An unsigned long value.

◆ AsInt64()

FragmentGraphAPI __int64 AsInt64 ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An __int64 value.

◆ AsUnsignedInt64()

FragmentGraphAPI unsigned __int64 AsUnsignedInt64 ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: An unsigned __int64 value.

◆ AsFloat()

FragmentGraphAPI float AsFloat ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A float value.

◆ AsDouble()

FragmentGraphAPI double AsDouble ( ) const

Tries to convert this variable to char and return the value.

If this variable is not a number, an exception is thrown.

Returns: A double value.

◆ AsStringA()

FragmentGraphAPI const char* AsStringA ( ) const

Tries to get the multi-byte string value of this variable.

If this variable is not a multi-byte string, an exception is thrown.

Returns: multi-byte string pointer. It's life time is controlled by the variable, you don't need to delete it.

◆ AsStringW()

FragmentGraphAPI const wchar_t* AsStringW ( ) const

Tries to get the Unicode string value of this variable.

If this variable is not a Unicode string, an exception is thrown.

Returns: Unicode string pointer. It's life time is controlled by the variable, you don't need to delete it.

◆ AsRefObject()

FragmentGraphAPI MaxSDK::Graphics::IRefObject* AsRefObject ( ) const

Tries to get the IRefObject pointer that is referenced by this variable.

If this variable is not an IRefObject variable, an exception is thrown.

Returns: This function directly returns the pointer to the IRefObject. It doesn't increase the reference count of that IRefObject.

◆ AsDictionary()

FragmentGraphAPI IVariableDictionary* AsDictionary ( ) const

Tries to get the dictionary pointer that is referenced by this variable.

If this variable is not a dictionary variable, an exception is thrown.

Returns: This function directly returns the pointer to the dictionary. It's life time is controlled by the variable, developer don't need to delete it.

◆ TryUpdateValue() [1/17]

FragmentGraphAPI bool TryUpdateValue ( char iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [2/17]

FragmentGraphAPI bool TryUpdateValue ( unsigned char iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [3/17]

FragmentGraphAPI bool TryUpdateValue ( wchar_t iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [4/17]

FragmentGraphAPI bool TryUpdateValue ( short iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [5/17]

FragmentGraphAPI bool TryUpdateValue ( unsigned short iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [6/17]

FragmentGraphAPI bool TryUpdateValue ( int iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [7/17]

FragmentGraphAPI bool TryUpdateValue ( unsigned int iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [8/17]

FragmentGraphAPI bool TryUpdateValue ( long iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [9/17]

FragmentGraphAPI bool TryUpdateValue ( unsigned long iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [10/17]

FragmentGraphAPI bool TryUpdateValue ( __int64 iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [11/17]

FragmentGraphAPI bool TryUpdateValue ( unsigned __int64 iValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] iValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [12/17]

FragmentGraphAPI bool TryUpdateValue ( float fValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] fValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [13/17]

FragmentGraphAPI bool TryUpdateValue ( double fValue )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] fValue input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ TryUpdateValue() [14/17]

FragmentGraphAPI bool TryUpdateValue ( const char * str )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] str input value.

Returns: true if the variable is a multi-byte string and is successfully updated, false otherwise.

◆ TryUpdateValue() [15/17]

FragmentGraphAPI bool TryUpdateValue ( const wchar_t * str )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] str input value.

Returns: true if the variable is an unicode string and is successfully updated, false otherwise.

◆ TryUpdateValue() [16/17]

FragmentGraphAPI bool TryUpdateValue ( MaxSDK::Graphics::IRefObject * pRefObject )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] pRefObject input value.

Returns: true if the variable is an IRefObject pointer and is successfully updated, false otherwise. If it succeeds, this function tries to release the old IRefObject that is referenced by the variable and increase the reference count of the input value.

◆ TryUpdateValue() [17/17]

FragmentGraphAPI bool TryUpdateValue ( const Variable & var )

Tries to update this variable's value, without changing this variable's type.

If the input value cannot be converted to this variable's type, returns false.

Parameters

[in] var input value.

Returns: true if the variable is successfully updated, false otherwise.

◆ operator=() [1/17]

FragmentGraphAPI Variable& operator= ( char rhs )

Converts this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [2/17]

FragmentGraphAPI Variable& operator= ( unsigned char rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [3/17]

FragmentGraphAPI Variable& operator= ( wchar_t rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [4/17]

FragmentGraphAPI Variable& operator= ( short rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [5/17]

FragmentGraphAPI Variable& operator= ( unsigned short rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [6/17]

FragmentGraphAPI Variable& operator= ( int rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [7/17]

FragmentGraphAPI Variable& operator= ( unsigned int rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [8/17]

FragmentGraphAPI Variable& operator= ( long rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [9/17]

FragmentGraphAPI Variable& operator= ( unsigned long rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [10/17]

FragmentGraphAPI Variable& operator= ( __int64 rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [11/17]

FragmentGraphAPI Variable& operator= ( unsigned __int64 rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [12/17]

FragmentGraphAPI Variable& operator= ( float rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [13/17]

FragmentGraphAPI Variable& operator= ( double rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [14/17]

FragmentGraphAPI Variable& operator= ( const char * rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [15/17]

FragmentGraphAPI Variable& operator= ( const wchar_t * rhs )

convert this variable to the input value type.

Then assign the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [16/17]

FragmentGraphAPI Variable& operator= ( MaxSDK::Graphics::IRefObject * rhs )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] rhs input value.

Returns: a reference to the variable itself.

◆ operator=() [17/17]

FragmentGraphAPI Variable& operator= ( const Variable & var )

convert this variable to the input value type, then assigns the input value to this variable.

Parameters

[in] var input value.

Returns: a reference to the variable itself.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Variable() [1/18]

◆ Variable() [2/18]

◆ Variable() [3/18]

◆ Variable() [4/18]

◆ Variable() [5/18]

◆ Variable() [6/18]

◆ Variable() [7/18]

◆ Variable() [8/18]

◆ Variable() [9/18]

◆ Variable() [10/18]

◆ Variable() [11/18]

◆ Variable() [12/18]

◆ Variable() [13/18]

◆ Variable() [14/18]

◆ Variable() [15/18]

◆ Variable() [16/18]

◆ Variable() [17/18]

◆ Variable() [18/18]

◆ ~Variable()

Member Function Documentation

◆ GetNetStringCount()

◆ ChangeType()

◆ GetType()

◆ AsChar()

◆ AsUnsignedChar()

◆ AsWideChar()

◆ AsShort()

◆ AsUnsignedShort()

◆ AsInt()

◆ AsUnsignedInt()

◆ AsLong()

◆ AsUnsignedLong()

◆ AsInt64()

◆ AsUnsignedInt64()

◆ AsFloat()

◆ AsDouble()

◆ AsStringA()

◆ AsStringW()

◆ AsRefObject()

◆ AsDictionary()

◆ TryUpdateValue() [1/17]

◆ TryUpdateValue() [2/17]

◆ TryUpdateValue() [3/17]

◆ TryUpdateValue() [4/17]

◆ TryUpdateValue() [5/17]

◆ TryUpdateValue() [6/17]

◆ TryUpdateValue() [7/17]

◆ TryUpdateValue() [8/17]

◆ TryUpdateValue() [9/17]

◆ TryUpdateValue() [10/17]

◆ TryUpdateValue() [11/17]

◆ TryUpdateValue() [12/17]

◆ TryUpdateValue() [13/17]

◆ TryUpdateValue() [14/17]

◆ TryUpdateValue() [15/17]

◆ TryUpdateValue() [16/17]

◆ TryUpdateValue() [17/17]

◆ operator=() [1/17]

◆ operator=() [2/17]

◆ operator=() [3/17]

◆ operator=() [4/17]

◆ operator=() [5/17]

◆ operator=() [6/17]

◆ operator=() [7/17]

◆ operator=() [8/17]

◆ operator=() [9/17]

◆ operator=() [10/17]

◆ operator=() [11/17]

◆ operator=() [12/17]

◆ operator=() [13/17]

◆ operator=() [14/17]

◆ operator=() [15/17]

◆ operator=() [16/17]

◆ operator=() [17/17]