IDataItem Interface Reference

import "Imaris.idl";

Inheritance diagram for IDataItem:

Public Member Functions
HRESULT	AddStatistics ([in] VARIANT aNames,[in] VARIANT aValues,[in] VARIANT aUnits,[in] VARIANT aFactors,[in] VARIANT aFactorNames,[in] VARIANT aIds)
HRESULT	GetColor ([out] FLOAT *aR,[out] FLOAT *aG,[out] FLOAT *aB,[out] FLOAT *aA)
HRESULT	GetParent ([out, retval] IDataContainer **aParent)
HRESULT	GetStatistics ([out] VARIANT *aNames,[out] VARIANT *aValues,[out] VARIANT *aUnits,[out] VARIANT *aFactors,[out] VARIANT *aFactorNames,[out] VARIANT *aIds)
HRESULT	SetColor ([in] FLOAT aR,[in] FLOAT aG,[in] FLOAT aB,[in] FLOAT aA)
Properties
BSTR	mName [get, set]
VARIANT_BOOL	mVisible [get, set]

---

Detailed Description

The DataItem is the parent object of all Surpass components (the Frame, the Volume object, the IsoSurface object, ...). It collects all the common properties, such as name, color, parent and child object(s), statistical values, etc.

---

Member Function Documentation

HRESULT IDataItem::AddStatistics	(	[in] VARIANT	aNames,
		[in] VARIANT	aValues,
		[in] VARIANT	aUnits,
		[in] VARIANT	aFactors,
		[in] VARIANT	aFactorNames,
		[in] VARIANT	aIds
	)

Add Statistics to the DataItem.

Parameters:

	aNames	Vector of Statistics Names
	aValues	Vector of Statistics Values
	aUnits	Vector of Units
	aFactors	Array of Factors
	aFactorNames	Vector of factor names
	aIds	Vector of ids

 %% The following MATLAB code sets custom statistics for the isoSurface DataItem.
 %% The IsoSurface object is assumed to be selected in the Surpass Scene tree.
 aIsoSurface=vImarisApplication.mSurpassSelection;
 aIsoSurface.AddStatistics(aNames,aValues,aUnits,aFactors,aFactorNames,aIds);
 

HRESULT IDataItem::GetColor	(	[out] FLOAT *	aR,
		[out] FLOAT *	aG,
		[out] FLOAT *	aB,
		[out] FLOAT *	aA
	)

Get the diffusion color of the DataItem.

Parameters:

	aR	The red component from the color [0..1]
	aG	The green component from the color [0..1]
	aB	The blue component from the color [0..1]
	aA	The alpha component (1-opacity) from the color [0..1]

 %% The following MATLAB code gets the diffusion color of the IsoSurface DataItem.
 %% The IsoSurface object is assumed to be selected in the Surpass Scene tree.
 aIsoSurface=vImarisApplication.mSurpassSelection;
 [aR,aG,aB,aA]=aIsoSurface.GetColor;
 

HRESULT IDataItem::GetParent

(

[out, retval] IDataContainer **

aParent

)

Get the DataItem's parent. If the object has no parent, as might be the case for objects that are created by the IFactory class but yet not added to the Surpass scene, an empty object (null, []) is returned.

Parameters:

aParent

[out] Parent IDataItem object

 %% The following MATLAB code returns the parent of the selected DataItem (the Volume object).
 %% The object is assumed to be selected in the Surpass Scene tree.
 aChild=vImarisApplication.mSurpassSelection
 aChild =
    Interface.Bitplane_Imaris_5.0_Type_Library.IVolume
 aParent=aChild.GetParent
 aParent =
    Interface.Bitplane_Imaris_5.0_Type_Library.IDataContainer
 

HRESULT IDataItem::GetStatistics	(	[out] VARIANT *	aNames,
		[out] VARIANT *	aValues,
		[out] VARIANT *	aUnits,
		[out] VARIANT *	aFactors,
		[out] VARIANT *	aFactorNames,
		[out] VARIANT *	aIds
	)

Get Statistics from the DataItem.

Parameters:

	aNames	Vector of Statistics Names
	aValues	Vector of Statistics Values
	aUnits	Vector of Units
	aFactors	Array of Factors
	aFactorNames	Vector of factor names
	aIds	Vector of aIds

 %% The following MATLAB code gets the statistics for the IsoSurface DataItem.
 %% The IsoSurface object is assumed to be selected in the Surpass Scene tree.
 aIsoSurface=vImarisApplication.mSurpassSelection;
 [aNames,aValues,aUnits,aFactors,aFactorNames,aIds]=aIsoSurface.GetStatistics;
 

HRESULT IDataItem::SetColor	(	[in] FLOAT	aR,
		[in] FLOAT	aG,
		[in] FLOAT	aB,
		[in] FLOAT	aA
	)

Set the diffusion color of the DataItem.

Parameters:

	aR	The red component from the color [0..1]
	aG	The green component from the color [0..1]
	aB	The blue component from the color [0..1]
	aA	The alpha component (1-opacity) from the color [0..1]

 %% The following MATLAB code sets the diffusion color of the IsoSurface DataItem to red and with a 50%% transparency.
 %% The IsoSurface object is assumed to be selected in the Surpass Scene tree.
 aIsoSurface=vImarisApplication.mSurpassSelection;
 aIsoSurface.SetColor(1.0,0.0,0.0,0.5);
 

---

Property Documentation

BSTR IDataItem::mName [get, set]

Get the name of the DataItem.

Parameters:

aName

[in] Name of the DataItem (string)

 %% The following MATLAB code returns the name of the current Surpass scene in a string.
 aName=vImarisApplication.mSurpassScene.mName;
 

Parameters:

aName

[in] Name of the DataItem (string)

Set the name of the DataItem.

 %% The following MATLAB code sets the name of the current Surpass scene to "Surpass scene".
 vImarisApplication.mSurpassScene.mName='Surpass Scene';
 

.mName must be of class char.

VARIANT_BOOL IDataItem::mVisible [get, set]

Get the visibility of the DataItem.

Parameters:

aVisible

[out] Visibility flag: either 0 (not visible) or 1 (visible)

 %% The following MATLAB code returns the visibility of the Surpass scene.
 aVisible=vImarisApplication.mSurpassScene.mVisible;
 

Set the visibility of the DataItem.

 %% The following MATLAB code sets the Surpass scene to invisible.
 vImarisApplication.mSurpassScene.mVisible=0;
 

.mVisible can be either 0 (not visible) or 1 (visible).

---

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

• Imaris.idl