IFactory Interface Reference

import "Imaris.idl";

Public Member Functions
HRESULT	CreateApplication ([out, retval] IApplication **aApplication)
HRESULT	CreateCells ([out, retval] ICells **aCells)
HRESULT	CreateClippingPlane ([out, retval] IClippingPlane **aClippingPlane)
HRESULT	CreateDataBuffer ([out, retval] IDataBuffer **aDataBuffer)
HRESULT	CreateDataContainer ([out, retval] IDataContainer **aDataContainer)
HRESULT	CreateDataSet ([out, retval] IDataSet **aDataSet)
HRESULT	CreateFactory ([out, retval] IFactory **aFactory)
HRESULT	CreateFilament ([out, retval] IFilament **aFilament)
HRESULT	CreateFrame ([out, retval] IFrame **aFrame)
HRESULT	CreateLightSource ([out, retval] ILightSource **aLightSource)
HRESULT	CreateMeasurementPoints ([out, retval] IMeasurementPoints **aMeasurementPoints)
HRESULT	CreateSpots ([out, retval] ISpots **aSpots)
HRESULT	CreateSurfaces ([out, retval] ISurfaces **aSurfaces)
HRESULT	CreateVolume ([out, retval] IVolume **aVolume)
HRESULT	IsApplication ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsApplication)
HRESULT	IsCells ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsCells)
HRESULT	IsClippingPlane ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsClippingPlane)
HRESULT	IsDataBuffer ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsDataBuffer)
HRESULT	IsDataContainer ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsDataContainer)
HRESULT	IsDataSet ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsDataSet)
HRESULT	IsFactory ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsFactory)
HRESULT	IsFilament ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsFilament)
HRESULT	IsFrame ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsFrame)
HRESULT	IsLightSource ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsLightSource)
HRESULT	IsMeasurementPoints ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsMeasurementPoints)
HRESULT	IsSpots ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsSpots)
HRESULT	IsSurfaces ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsSurfaces)
HRESULT	IsVolume ([in] IDispatch aDispatch,[out, retval] VARIANT_BOOL aIsVolume)
HRESULT	ToApplication ([in] IDispatch aDispatch,[out, retval] IApplication *aApplication)
HRESULT	ToCells ([in] IDispatch aDispatch,[out, retval] ICells *aCells)
HRESULT	ToClippingPlane ([in] IDispatch aDispatch,[out, retval] IClippingPlane *aClippingPlane)
HRESULT	ToDataBuffer ([in] IDispatch aDispatch,[out, retval] IDataBuffer *aDataBuffer)
HRESULT	ToDataContainer ([in] IDispatch aDispatch,[out, retval] IDataContainer *aDataContainer)
HRESULT	ToDataSet ([in] IDispatch aDispatch,[out, retval] IDataSet *aDataSet)
HRESULT	ToFactory ([in] IDispatch aDispatch,[out, retval] IFactory *aFactory)
HRESULT	ToFilament ([in] IDispatch aDispatch,[out, retval] IFilament *aFilament)
HRESULT	ToFrame ([in] IDispatch aDispatch,[out, retval] IFrame *aFrame)
HRESULT	ToLightSource ([in] IDispatch aDispatch,[out, retval] ILightSource *aLightSource)
HRESULT	ToMeasurementPoints ([in] IDispatch aDispatch,[out, retval] IMeasurementPoints *aMeasurementPoints)
HRESULT	ToSpots ([in] IDispatch aDispatch,[out, retval] ISpots *aSpots)
HRESULT	ToSurfaces ([in] IDispatch aDispatch,[out, retval] ISurfaces *aSurfaces)
HRESULT	ToVolume ([in] IDispatch aDispatch,[out, retval] IVolume *aVolume)

Detailed Description

This factory allows to create new instances of a class within the same Server. If the COM client uses its mechanism to create a new object for Imaris, Imaris will start a new running instance as COM server.

Member Function Documentation

HRESULT IFactory::CreateApplication ( [out, retval] IApplication ** aApplication )

Create a new Application instance.

Parameters:

aApplication

[out] Created Application

 %% The following MATLAB code creates a new Application
 aApplication=vImarisApplication.mFactory.CreateApplication;

HRESULT IFactory::CreateCells ( [out, retval] ICells ** aCells )

Create a new Cells instance.

Parameters:

aCells

[out] Created Cells

 %% The following MATLAB code creates a new Cells object
 aCells=vImarisApplication.mFactory.CreateCells;

HRESULT IFactory::CreateClippingPlane ( [out, retval] IClippingPlane ** aClippingPlane )

Create a new ClippingPlane instance.

Parameters:

aClippingPlane

[out] Created Clipping Plane

 %% The following MATLAB code creates a new Clipping Plane
 aClippingPlane=vImarisApplication.mFactory.CreateClippingPlane;

HRESULT IFactory::CreateDataBuffer ( [out, retval] IDataBuffer ** aDataBuffer )

Create a new DataBuffer instance.

Parameters:

aDataBuffer

[out] Created DataBuffer

 %% The following MATLAB code creates a new DataBuffer
 aDataBuffer=vImarisApplication.mFactory.CreateDataBuffer;

HRESULT IFactory::CreateDataContainer ( [out, retval] IDataContainer ** aDataContainer )

Create a new DataContainer instance.

Parameters:

aDataContainer

[out] Created DataContainer

 %% The following MATLAB code creates a new data container
 aDataContainer=vImarisApplication.mFactory.CreateDataContainer;

HRESULT IFactory::CreateDataSet ( [out, retval] IDataSet ** aDataSet )

Create a new DataSet instance.

Parameters:

aDataSet

[out] Created DataSet

 %% The following MATLAB code creates a new DataSet
 aDataSet=vImarisApplication.mFactory.CreateDataSet;

HRESULT IFactory::CreateFactory ( [out, retval] IFactory ** aFactory )

Create a new Factory instance.

Parameters:

aFactory

[out] Created Factory

 %% The following MATLAB code creates a new Factory object
 aFactory=vImarisApplication.mFactory.CreateFactory;

HRESULT IFactory::CreateFilament ( [out, retval] IFilament ** aFilament )

Create a new Filament instance.

Parameters:

aFilament

[out] Created Filament

 %% The following MATLAB code creates a new Filament
 aFilament=vImarisApplication.mFactory.CreateFilament;

HRESULT IFactory::CreateFrame ( [out, retval] IFrame ** aFrame )

Create a new Frame instance.

Parameters:

aFrame

[out] Created Frame

 %% The following MATLAB code creates a new Frame object
 aFrame=vImarisApplication.mFactory.CreateFrame;

HRESULT IFactory::CreateLightSource ( [out, retval] ILightSource ** aLightSource )

Create a new LightSource instance.

Parameters:

aLightSource

[out] Created Light Source

 %% The following MATLAB code creates a new Light Source object
 aLightSource=vImarisApplication.mFactory.CreateLightSource;

HRESULT IFactory::CreateMeasurementPoints ( [out, retval] IMeasurementPoints ** aMeasurementPoints )

Create a new MeasurementPoints instance.

HRESULT IFactory::CreateSpots ( [out, retval] ISpots ** aSpots )

Create a new Spots instance.

Parameters:

aSpots

[out] Created Spots

 %% The following MATLAB code creates a new Spots object
 aSpots=vImarisApplication.mFactory.CreateSpots;

HRESULT IFactory::CreateSurfaces ( [out, retval] ISurfaces ** aSurfaces )

Create a new Surfaces instance.

Parameters:

aSurfaces

[out] Created Surfaces

 %% The following MATLAB code creates a new Surfaces object
 aSurfaces=vImarisApplication.mFactory.CreateSurfaces;

HRESULT IFactory::CreateVolume ( [out, retval] IVolume ** aVolume )

Create a new Volume instance.

Parameters:

aVolume

[out] Created Volume

 %% The following MATLAB code creates a new Volume object
 aVolume=vImarisApplication.mFactory.CreateVolume;

HRESULT IFactory::IsApplication	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsApplication
	)

Check if an object is a Application.

Parameters:

	aDispatch	[in] Object to be checked
	aIsApplication	[out] (boolean) Returns 1 (true) if the object is an Application

 %% The following MATLAB code checks whether the Imaris Server is an Application
 vImarisServer=actxserver('ImarisServer.Server');
 aIsApplication=vImarisApplication.mFactory.IsApplication(vImarisServer)
 aIsApplication =
   0
 %% No, it is not.

HRESULT IFactory::IsCells	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsCells
	)

Check if an object is a Surfaces.

Parameters:

	aDispatch	[in] Object to be checked
	aIsCells	[out] (boolean) Returns 1 (true) if the object is a Cells

 %% The following MATLAB code checks whether the selected object in the surpass scene is a cells
 aIsCells=vImarisApplication.mFactory.IsSurfaces(vImarisApplication.mSurpassSelection)
 aIsSurfaces =
   0
 %% No, it is not.

HRESULT IFactory::IsClippingPlane	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsClippingPlane
	)

Check if an object is a ClippingPlane.

Parameters:

	aDispatch	[in] Object to be checked
	aIsClippingPlane	[out] (boolean) Returns 1 (true) if the object is a Clipping Plane

 %% The following MATLAB code checks whether the selected object in the surpass scene is a Clippping Plane
 aIsClippingPlane=vImarisApplication.mFactory.IsFilament(vImarisApplication.mSurpassSelection)
 aIsClippingPlane =
   1
 %% Yes, it is.

HRESULT IFactory::IsDataBuffer	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsDataBuffer
	)

Check if an object is a DataBuffer.

Parameters:

	aDispatch	[in] Object to be checked
	aIsDataBuffer	[out] (boolean) Returns 1 (true) if the object is an DataSet

 %% The following MATLAB code checks whether the created DataBuffer is indeed a valid DataBuffer
 aIsDataBuffer=vImarisApplication.mFactory.IsDataBuffer(vImarisApplication.mFactory.CreateDataBuffer)
 aIsDataBuffer =
   1
 %% Of course it is.

HRESULT IFactory::IsDataContainer	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsDataContainer
	)

Check if an object is a DataContainer.

Parameters:

	aDispatch	[in] Object to be checked
	aIsDataContainer	[out] (boolean) Returns 1 (true) if the object is a data container

 %% The following MATLAB code checks whether the Surpass scene is a data container
 aIsDataContainer=vImarisApplication.mFactory.IsDataContainer(vImarisApplication.mSurpassScene)
 aIsDataContainer =
   1
 %% Yes, it is.

HRESULT IFactory::IsDataSet	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsDataSet
	)

Check if an object is a DataSet.

Parameters:

	aDispatch	[in] Object to be checked
	aIsDataSet	[out] (boolean) Returns 1 (true) if the object is an DataSet

 %% The following MATLAB code checks whether vImarisApplication.mDataSet is a DataSet
 aIsDataSet=vImarisApplication.mFactory.IsDataSet(vImarisApplication.mDataSet)
 aIsDataSet =
   1
 %% Of course it is.

HRESULT IFactory::IsFactory	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsFactory
	)

Check if an object is a Factory.

Parameters:

	aDispatch	[in] Object to be checked
	aIsFactory	[out] (boolean) Returns 1 (true) if the object is a factory

 %% The following MATLAB code checks whether the surpass camera is a factory
 aIsFactory=vImarisApplication.mFactory.IsFactory(vImarisApplication.mSurpassCamera)
 aIsFactory =
   0
 %% No, it is not.

HRESULT IFactory::IsFilament	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsFilament
	)

Check if an object is a Filament.

Parameters:

	aDispatch	[in] Object to be checked
	aIsFilament	[out] (boolean) Returns 1 (true) if the object is a Filament

 %% The following MATLAB code checks whether the selected object in the surpass scene is a Filament
 aIsFilament=vImarisApplication.mFactory.IsFilament(vImarisApplication.mSurpassSelection)
 aIsFilament =
   0
 %% No, it is not.

HRESULT IFactory::IsFrame	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsFrame
	)

Check if an object is a Frame.

Parameters:

	aDispatch	[in] Object to be checked
	aIsFrame	[out] (boolean) Returns 1 (true) if the object is a frame

 %% The following MATLAB code checks whether the selected object in the surpass scene is a frame
 aIsFrame=vImarisApplication.mFactory.IsFrame(vImarisApplication.mSurpassSelection)
 aIsFrame =
   1
 %% Yes, it is.

HRESULT IFactory::IsLightSource	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsLightSource
	)

Check if an object is a LightSource.

Parameters:

	aDispatch	[in] Object to be checked
	aIsLightSource	[out] (boolean) Returns 1 (true) if the object is a light source

 %% The following MATLAB code checks whether the selected object in the surpass scene is a light source
 aIsLightSource=vImarisApplication.mFactory.IsLightSource(vImarisApplication.mSurpassSelection)
 aIsLightSource =
   1
 %% Yes, it is.

HRESULT IFactory::IsMeasurementPoints	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsMeasurementPoints
	)

Check, if an object is a VectorField. Convert an object to a VectorField. If the type doesn't match, en empty object (null) is returned. Create a new VectorField instance. Check, if an object is a MeasurementPoints.

HRESULT IFactory::IsSpots	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsSpots
	)

Check if an object is a Spots.

Parameters:

	aDispatch	[in] Object to be checked
	aIsSpots	[out] (boolean) Returns 1 (true) if the object is a spot

 %% The following MATLAB code checks whether the selected object in the SurpassScene is a spot
 aIsSpots=vImarisApplication.mFactory.IsSpots(vImarisApplication.mSurpassSelection)
 aIsSpots =
   0
 %% No, it is not.

HRESULT IFactory::IsSurfaces	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsSurfaces
	)

Check if an object is a Surfaces.

Parameters:

	aDispatch	[in] Object to be checked
	aIsSurfaces	[out] (boolean) Returns 1 (true) if the object is a surfaces

 %% The following MATLAB code checks whether the selected object in the surpass scene is a surfaces
 aIsSurfaces=vImarisApplication.mFactory.IsSurfaces(vImarisApplication.mSurpassSelection)
 aIsSurfaces =
   0
 %% No, it is not.

HRESULT IFactory::IsVolume	(	[in] IDispatch *	aDispatch,
		[out, retval] VARIANT_BOOL *	aIsVolume
	)

Check if an object is a Volume.

Parameters:

	aDispatch	[in] Object to be checked
	aIsVolume	[out] (boolean) Returns 1 (true) if the object is a volume

 %% The following MATLAB code checks whether the selected object in the surpass scene is a volume
 aIsVolume=vImarisApplication.mFactory.IsVolume(vImarisApplication.mSurpassSelection)
 aIsVolume =
   1
 %% Yes, it is.

HRESULT IFactory::ToApplication	(	[in] IDispatch *	aDispatch,
		[out, retval] IApplication **	aApplication
	)

Convert an object to a Application. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aApplication	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToCells	(	[in] IDispatch *	aDispatch,
		[out, retval] ICells **	aCells
	)

Convert an object to a Cells. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aCells	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToClippingPlane	(	[in] IDispatch *	aDispatch,
		[out, retval] IClippingPlane **	aClippingPlane
	)

Convert an object to a ClippingPlane. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aClippingPlane	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToDataBuffer	(	[in] IDispatch *	aDispatch,
		[out, retval] IDataBuffer **	aDataBuffer
	)

Convert an object to a DataBuffer. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aDataBuffer	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToDataContainer	(	[in] IDispatch *	aDispatch,
		[out, retval] IDataContainer **	aDataContainer
	)

Convert an object to a DataContainer. If the type doesn't match, an empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aDataContainer	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToDataSet	(	[in] IDispatch *	aDispatch,
		[out, retval] IDataSet **	aDataSet
	)

Convert an object to a DataSet. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aDataSet	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToFactory	(	[in] IDispatch *	aDispatch,
		[out, retval] IFactory **	aFactory
	)

Convert an object to a Factory. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aFactory	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToFilament	(	[in] IDispatch *	aDispatch,
		[out, retval] IFilament **	aFilament
	)

Convert an object to a Filament. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aFilament	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToFrame	(	[in] IDispatch *	aDispatch,
		[out, retval] IFrame **	aFrame
	)

Convert an object to a Frame. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aFrame	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToLightSource	(	[in] IDispatch *	aDispatch,
		[out, retval] ILightSource **	aLightSource
	)

Convert an object to a LightSource. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aLightSource	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToMeasurementPoints	(	[in] IDispatch *	aDispatch,
		[out, retval] IMeasurementPoints **	aMeasurementPoints
	)

Convert an object to a MeasurementPoints. If the type doesn't match, en empty object (null) is returned.

HRESULT IFactory::ToSpots	(	[in] IDispatch *	aDispatch,
		[out, retval] ISpots **	aSpots
	)

Convert an object to a Spots. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aSpots	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToSurfaces	(	[in] IDispatch *	aDispatch,
		[out, retval] ISurfaces **	aSurfaces
	)

Convert an object to a Surfaces. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aSurfaces	[out] Converted object (null is conversion failed)

HRESULT IFactory::ToVolume	(	[in] IDispatch *	aDispatch,
		[out, retval] IVolume **	aVolume
	)

Convert an object to a Volume. If the type doesn't match, en empty object (null) is returned.

Parameters:

	aDispatch	[in] Object to be converted
	aVolume	[out] Converted object (null is conversion failed)

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

Imaris.idl

IFactory Interface Reference

Public Member Functions

Detailed Description

Member Function Documentation