Controls separate element of a scene.
Methods
AttributesBoolGet
Gets value of attribute. This method works only with attributes, whose values are boolean.
Syntax
void AttributesBoolGet( string _bsName, out int _pbValue )
Parameters
_bsName - name of attribute
_pbValue - value of attribute
AttributesBoolSet
Sets value to attribute. This method works only with attributes, whose values are boolean.
Syntax
void AttributesBoolSet( string _bsName, int _bValue )
Parameters
_bsName - name of attribute
_bValue - value of attribute
AttributesClone
Creates a copy of attributes.
Syntax
void AttributesClone( out IMAttributes _ppClone )
Parameters
_ppClone - copy of attributes
AttributesDoubleGet
Gets value of attribute. This method works only with attributes, whose values are double.
Syntax
void AttributesDoubleGet( string _bsName, out double _pdblValue )
Parameters
_bsName - name of attribute
_pdblValue - value of attribute
AttributesDoubleSet
Sets value to attribute. This method works only with attributes, whose values are double.
Syntax
void AttributesDoubleSet( string _bsName, double _dblValue )
Parameters
_bsName - name of attribute
_dblValue - value of attribute
AttributesGetByIndex
Gets attribute by its index.
Syntax
void AttributesGetByIndex( int _nIndex, out string _pbsName, out string _pbsValue )
Parameters
_nIndex - index of attribute
_pbsName - name of attribute
_pbsValue - value of attribute
AttributesGetCount
Gets count of attributes.
Syntax
void AttributesGetCount( out int _pnCount )
Parameters
_pnCount - number of attributes
AttributesHave
Indicates whether the attribute is existed.
Syntax
void AttributesHave( string _bsName, out int _pbHave, out string _pbsValueOrDefault )
Parameters
_bsName - name of the attribute
_pbHave - "0" means that the attribute does not exist. "1" means that the attribute exists.
_pbsValueOrDefault - value of the attribute if it exists or default value in other case
AttributesInfoGet
Get attribute information (see eMInfoType for details)
Syntax
void AttributesInfoGet( string _bsName, eMInfoType _eType, out string _pbsInfo )
Parameters
_bsName - name of attribute
_eType - type of attribute information
_pbsInfo - additional information
AttributesInfoGetByIndex
Get attribute information by index of the attribute.
Syntax
void AttributesInfoGetByIndex( int _nIndex, out string _pbsName )
Parameters
_nIndex - index of the attribute
_pbsName - name of the attribute
AttributesInfoGetCount
Gets the count of attribute information fields.
Syntax
void AttributesInfoGetCount( out int _pnCount )
Parameters
_pnCount - number of information fields
AttributesIntGet
Gets value of attribute. This method works only with attributes, whose values are integer.
Syntax
void AttributesIntGet( string _bsName, out int _pnValue )
Parameters
_bsName - name of attribute
_pnValue - value of attribute
AttributesIntSet
Sets value of attribute. This method works only with attributes, whose values are integer.
Syntax
void AttributesIntSet( string _bsName, int _nValue )
Parameters
_bsName - name of attribute
_nValue - value of attribute
AttributesMultipleSet
Sets values to collection of attributes.
Syntax
void AttributesMultipleSet( string _bsAttributesList, eMUpdateType _eUpdateType )
Parameters
_bsAttributesList - list of attributes with their values
_eUpdateType - type of update
AttributesRemove
Removes the attribute.
Syntax
void AttributesRemove( string _bsName )
Parameters
_bsName - name of attribute
AttributesRemoveAll
Removes all attributes.
Syntax
void AttributesRemoveAll()
AttributesSave
Saves all attributes to string.
Syntax
void AttributesSave( out string _pbsAttributesList )
Parameters
_pbsAttributesList - list of attributes
AttributesSet
Sets multiple attributes.
Syntax
void AttributesSet( IMAttributes _pAttributesList, eMUpdateType _eUpdateType )
Parameters
_pAttributesList - list of attributes
_eUpdateType - type of update
AttributesStringGet
Gets value of attribute. This method works only with attributes, whose values are strings.
Syntax
void AttributesStringGet( string _bsName, out string _pbsValue )
Parameters
_bsName - name of attribute
_pbsValue - value of attribute
AttributesStringSet
Sets value of attribute. This method works only with attributes, whose values are strings.
Syntax
void AttributesStringSet( string _bsName, string _bsValue )
Parameters
_bsName - name attribute
_bsValue - value of attribute
AttributesValuesInfoGet
Gets information about values of the attribute
Syntax
void AttributesValuesInfoGet( string _bsName, string _bsValue, string _bsType, out string _pbsInfo )
Parameters
_bsName - attribute name
_bsValue - value of attribute
_bsType - type of attribute
_pbsInfo - information about the attribute
ElementAbsolutePosGet
Gets absolute position of the scene element (not relative to a parent).
Syntax
void ElementAbsolutePosGet( out double _pdblXPos, out double _pdblYPos, out double _pdblWidth, out double _pdblHeight )
Parameters
_pdblXPos - X position of the element
_pdblYPos - Y position of the element
_pdblWidth - width of the element
_pdblHeight - height of the element
ElementAbsolutePosSet
Sets absolute position of the scene element (not relative to a parent).
Syntax
void ElementAbsolutePosSet( double _dblXPos, double _dblYPos, double _dblWidth, double _dblHeight )
Parameters
_dblXPos - X position
_dblYPos - Y position
_dblWidth - width of the element
_dblHeight - height of the element
ElementBoolSet
Sets attribute value smoothly during the time interval. This method works only with attributes, whose values are boolean.
Syntax
void ElementBoolSet( string _bsAttributeName, int _bValue, double _dblTimeForChange )
Parameters
_bsAttributeName - name of the attribute
_bValue - value of the attribute
_dblTimeForChange - time interval for changes in seconds
ElementDetach
Removes the element smoothly.
Syntax
void ElementDetach( double _dblTimeForChange )
Parameters
_dblTimeForChange - time interval for changes in seconds
ElementDoubleSet
Sets attribute value smoothly during the time interval. This method works only with attributes, whose values are double.
Syntax
void ElementDoubleSet( string _bsAttributeName, double _dblValue, double _dblTimeForChange )
Parameters
_bsAttributeName - name of the attribute
_dblValue - value of the attribute
_dblTimeForChange - time interval for changes in seconds
ElementGet
Gets whole information about the element.
Syntax
void ElementGet( out string _pbsElementType, out string _pbsXMLDescription )
Parameters
_pbsElementType - type of the element
_pbsXMLDescription - description of element in XML format
ElementInfoGet
Gets information about this element
Syntax
void ElementInfoGet( string _bsInfoType, out string _pbsDecription )
Parameters
_bsInfoType - required type of information
_pbsDecription - result description
ElementInvoke
Calls special action for the element (for example, select, highlight and so on).
Syntax
void ElementInvoke( string _bsCommand, string _bsParam, double _dblTimeForChange )
Parameters
_bsCommand - name of the action
_bsParam - parameters of the action
_dblTimeForChange - time interval for changes in seconds
ElementMediaSet
Changes media content of the element (optionall with transitions).
Syntax
void ElementMediaSet( object _pExternOrRef, string _bsPath, string _bsParam, double _dblTimeForChange )
Parameters
_pExternOrRef - reference to external object (for example, live source)
_bsPath - path to the source
_bsParam - parameters for adding
_dblTimeForChange - time interval for changes in seconds
ElementMultipleSet
Sets values to collection of attributes for the element smoothly.
Syntax
void ElementMultipleSet( string _bsAttributesList, double _dblTimeForChange )
Parameters
_bsAttributesList - list of attributes
_dblTimeForChange - time interval for changes in seconds
ElementParentGet
Gets an parent element of the current element.
Syntax
void ElementParentGet( out MElement _ppParent )
Parameters
_ppParent - parent element
ElementParentSet
Sets a parent element of the current element.
Syntax
void ElementParentSet( MElement _pParent )
Parameters
_pParent - parent element
ElementReorder
Changes the order of the element. Only for 2D case.
Syntax
void ElementReorder( int _nAddIndex )
Parameters
_nAddIndex - index change number Possible values: positive value - position changes in direction to the beginning. negative value - position changes in direction to the end.
ElementSet
Changes the whole element.
Syntax
void ElementSet( string _bsElementType, string _bsXMLDescription, double _dblTimeForChange )
Parameters
_bsElementType - type of the element
_bsXMLDescription - description of the element
_dblTimeForChange - time interval for changes in seconds
ElementStringSet
Sets attribute value smoothly during the time interval. This method works only with attributes, whose values are strings.
Syntax
void ElementStringSet( string _bsAttributeName, string _bsValue, double _dblTimeForChange )
Parameters
_bsAttributeName - name of the attribute
_bsValue - value of the attribute
_dblTimeForChange - time interval for changes in seconds
ElementTypeGet
Returns type of the element.
Syntax
void ElementTypeGet( out string _pbsElementType )
Parameters
_pbsElementType - type of the element