IDataContainer Interface Reference

import "Imaris.idl";

Inheritance diagram for IDataContainer:

Public Member Functions
HRESULT	AddChild ([in] IDataItem *aDataItem,[in, defaultvalue(-1)] LONG aIndex)
HRESULT	GetChild ([in] LONG aIndex,[out, retval] IDataItem **aDataItem)
HRESULT	GetNumberOfChildren ([out, retval] ULONG *aNumberOfChildren)
HRESULT	RemoveChild ([in] IDataItem *aDataItem)

---

Detailed Description

A DataContainer contains multiple DataItem children. For instance, the Surpass scene contains a Frame, a Volume object, ...

---

Member Function Documentation

HRESULT IDataContainer::AddChild	(	[in] IDataItem *	aDataItem,
		[in, defaultvalue(-1)] LONG	aIndex
	)

Add (or move) a child DataItem to the DataContainer. The index defines the position (counting starts at 0, -1 appends it as the last child). If the object is already a child of another group, it is moved to the new location.

Parameters:

	aDataItem	[in] IDataItem object
	aIndex	[in] Position to store the object in the IDataContainer (set to -1 to have it added at the last position)

 %% The following MATLAB code creates a Volume object and adds it to the Surpass scene.
 %% Remark: do not add more than one Volume object to the same Surpass scene.
 aVolume=vImarisApplication.mFactory.CreateVolume;
 vImarisApplication.mSurpassScene.AddChild(aVolume);
 %% Use .AddChild(aVolume,-1) it to add it as last child.
 

HRESULT IDataContainer::GetChild	(	[in] LONG	aIndex,
		[out, retval] IDataItem **	aDataItem
	)

Get the child at a specified index from the DataContainer (counting starts with 0).

Parameters:

	aIndex	[in] Position where the object is stored in the IDataContainer
	aDataItem	[out] IDataItem object

 %% The following MATLAB code gets the Frame object from the Surpass scene.
 %% The Frame object is assumed to be selected in the Surpass Scene tree.
 aDataItem=vImarisApplication.mSurpassSelection;
 ans =
 	  Interface.Bitplane_Imaris_5.0_Type_Library.IFrame
 

HRESULT IDataContainer::GetNumberOfChildren

(

[out, retval] ULONG *

aNumberOfChildren

)

Returns the number of children of the DataContainer.

Parameters:

aNumberOfChildren

[out] Number of children of the DataContainer.

 %% The following MATLAB code returns the number of children of the Surpass scene.
 aNumberOfChildren=vImarisApplication.mSurpassScene.GetNumberOfChildren;
 

HRESULT IDataContainer::RemoveChild

(

[in] IDataItem *

aDataItem

)

Remove a child from the DataContainer. If the called object is NOT a child of the DataContainer, nothing happens.

Parameters:

aDataItem

[in] IDataItem object

 %% The following MATLAB code removes the Volume object from the Surpass scene.
 %% The Volume object is assumed to be selected in the Surpass Scene tree.
 aVolume=vImarisApplication.mSurpassSelection;
 vImarisApplication.mSurpassScene.RemoveChild(aVolume);
 

---

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

• Imaris.idl