ISurpassCamera Interface Reference

import "Imaris.idl";

Public Member Functions
HRESULT	Fit ()
HRESULT	GetOrientationAxisAngle ([out] FLOAT aPositionX,[out] FLOAT aPositionY,[out] FLOAT aPositionZ,[out] FLOAT aAngle)
HRESULT	GetOrientationQuaternion ([out] FLOAT aQ0,[out] FLOAT aQ1,[out] FLOAT aQ2,[out] FLOAT aQ3)
HRESULT	GetPosition ([out] FLOAT aPositionX,[out] FLOAT aPositionY,[out] FLOAT *aPositionZ)
HRESULT	SetOrientationAxisAngle ([in] FLOAT aPositionX,[in] FLOAT aPositionY,[in] FLOAT aPositionZ,[in] FLOAT aAngle)
HRESULT	SetOrientationQuaternion ([in] FLOAT aQ0,[in] FLOAT aQ1,[in] FLOAT aQ2,[in] FLOAT aQ3)
HRESULT	SetPosition ([in] FLOAT aPositionX,[in] FLOAT aPositionY,[in] FLOAT aPositionZ)
Properties
FLOAT	mFocus `[get, set]`
FLOAT	mHeight `[get, set]`
VARIANT_BOOL	mOrthographic `[get, set]`
VARIANT_BOOL	mPerspective `[get, set]`

Detailed Description

The surpass camera allows the set up of the view in surpass: angle, zoom, perspective, etc.

Member Function Documentation

HRESULT ISurpassCamera::Fit ( )

Sets the zoom and the position so that the bounding box of all visible objects fits into the window. The orientation is not changed.

 %% The following MATLAB code fits the view of the SurpassCamera object.
 vImarisApplication.mSurpassCamera.Fit;

HRESULT ISurpassCamera::GetOrientationAxisAngle	(	[out] FLOAT *	aPositionX,
		[out] FLOAT *	aPositionY,
		[out] FLOAT *	aPositionZ,
		[out] FLOAT *	aAngle
	)

Returns the orientation (axis/angle) of the camera.

Parameters:

	aPositionX	[out] X coordinate (float)
	aPositionY	[out] Y coordinate (float)
	aPositionZ	[out] Z coordinate (float)
	aAngle	[out] aAngle (float)

 %% The following MATLAB code gets the orientation (axis/angle) of the SurpassCamera object.
 [aPositionX,aPositionY,aPositionZ,aAngle]=vImarisApplication.mSurpassCamera.GetOrientationAxisAngle
 aPositionX =
    0.9613
 aPositionY =
    0.1110
 aPositionZ =
    -0.2519
 aAngle =
    1.4157

HRESULT ISurpassCamera::GetOrientationQuaternion	(	[out] FLOAT *	aQ0,
		[out] FLOAT *	aQ1,
		[out] FLOAT *	aQ2,
		[out] FLOAT *	aQ3
	)

Return the orientation (quaternion) of the camera.

Parameters:

	aQ0	[out] 1st entry in the quaternion (float)
	aQ1	[out] 2nd entry in the quaternion (float)
	aQ2	[out] 3rd entry in the quaternion (float)
	aQ3	[out] 4th entry in the quaternion (float)

 %% The following MATLAB code gets the orientation (quaternion) of the SurpassCamera object.
 [aQ0,aQ1,aQ2,aQ3]=vImarisApplication.mSurpassCamera.GetOrientationQuaternion
 aQ0 =
    0.6251
 aQ1 =
    0.0722
 aQ2 =
    -0.1638
 aQ3 =
    0.7598

HRESULT ISurpassCamera::GetPosition	(	[out] FLOAT *	aPositionX,
		[out] FLOAT *	aPositionY,
		[out] FLOAT *	aPositionZ
	)

Return the camera position.

Parameters:

	aPositionX	[out] Camera position, X coordinate (float)
	aPositionY	[out] Camera position, Y coordinate (float)
	aPositionZ	[out] Camera position, Z coordinate (float)

 %% The following MATLAB code gets the camera position of the SurpassCamera object.
 [aPositionX,aPositionY,aPositionZ]=vImarisApplication.mSurpassCamera.GetPosition
 aPositionX =
    13.8150
 aPositionY =
    -83.3059
 aPositionZ =
    33.0063

HRESULT ISurpassCamera::SetOrientationAxisAngle	(	[in] FLOAT	aPositionX,
		[in] FLOAT	aPositionY,
		[in] FLOAT	aPositionZ,
		[in] FLOAT	aAngle
	)

Sets the orientation (axis/angle) of the camera.

Parameters:

	aPositionX	[in] X coordinate (float)
	aPositionY	[in] Y coordinate (float)
	aPositionZ	[in] Z coordinate (float)
	aAngle	[in] aAngle (float)

 %% The following MATLAB code gets the orientation (axis/angle) of the SurpassCamera object.
 aPositionX=1.00;
 aPositionY=0.20;
 aPositionZ=-0.50;
 aAngle=0.57;
 vImarisApplication.mSurpassCamera.GetOrientationAxisAngle(aPositionX,aPositionY,aPositionZ,aAngle);

HRESULT ISurpassCamera::SetOrientationQuaternion	(	[in] FLOAT	aQ0,
		[in] FLOAT	aQ1,
		[in] FLOAT	aQ2,
		[in] FLOAT	aQ3
	)

Set the orientation (quaternion) of the camera.

Parameters:

	aQ0	[in] 1st entry in the quaternion (float)
	aQ1	[in] 2nd entry in the quaternion (float)
	aQ2	[in] 3rd entry in the quaternion (float)
	aQ3	[in] 4th entry in the quaternion (float)

 %% The following MATLAB code sets the orientation (quaternion) of the SurpassCamera object.
 aQ0=0.50;
 aQ1=0.00;
 aQ2=-0.20;
 aQ3=0.50;
 vImarisApplication.mSurpassCamera.SetOrientationQuaternion(aQ0,aQ1,aQ2,aQ3);

HRESULT ISurpassCamera::SetPosition	(	[in] FLOAT	aPositionX,
		[in] FLOAT	aPositionY,
		[in] FLOAT	aPositionZ
	)

Set the camera position.

Parameters:

	aPositionX	[in] Camera position, X coordinate (float)
	aPositionY	[in] Camera position, Y coordinate (float)
	aPositionZ	[in] Camera position, Z coordinate (float)

 %% The following MATLAB code sets the camera position of the SurpassCamera object.
 aPositionX= 15.00;
 aPositionY=-75.00;
 aPositionZ= 25.00;
 vImarisApplication.mSurpassCamera.SetPosition(aPositionX,aPositionY,aPositionZ);

Property Documentation

FLOAT ISurpassCamera::mFocus [get, set]

Get the focal distance of the camera. This distance specifies the virtual rotation center of the camera.

Parameters:

aFocus

[out] Focal distance (float)

 %% The following MATLAB code gets the focal distance of the SurpassCamera object.
 aFocus=vImarisApplication.mSurpassCamera.mFocus
 aFocus =
    110.5677

Set the focal distance of the camera. This distance specifies the virtual rotation center of the camera.

Parameters:

aFocus

[in] Focal distance (float)

 %% The following MATLAB code sets the focal distance of the SurpassCamera object.
 aFocus=150;
 vImarisApplication.mSurpassCamera.mFocus=aFocus;

FLOAT ISurpassCamera::mHeight [get, set]

Get the viewing height (angle) of the camera.

Parameters:

aHeight

[out] Viewing height (float)

 %% The following MATLAB code gets the viewing height of the SurpassCamera object.
 aHeight=vImarisApplication.mSurpassCamera.mHeight
 aHeight =
    0.7854

Set the viewing height (angle).

Parameters:

aHeight

[in] Viewing height (float)

 %% The following MATLAB code sets the viewing height of the SurpassCamera object.
 aHeight=1.00;
 vImarisApplication.mSurpassCamera.mHeight=aHeight;

VARIANT_BOOL ISurpassCamera::mOrthographic [get, set]

Get the camera type (perspective or orthographic) (complementary value to "mPerspective")

Parameters:

aOrthographic

[out] Camera type (1 - orthographic, 0 - perspective)

 %% The following MATLAB code gets the type of the SurpassCamera object..
 aOrthographic=vImarisApplication.mSurpassCamera.mOthographic
 aOrthographic =
    0

Set the camera type (true - orthographic, false - perspective) (complementary value to "mPerspective")

Parameters:

aOrthographic

[in] Camera type (1 - orthographic, 0 - perspective)

 %% The following MATLAB code sets the type of the of the SurpassCamera object to orthographic.
 aOrthographic=1;
 vImarisApplication.mSurpassCamera.mOthographic=aOrthographic;

VARIANT_BOOL ISurpassCamera::mPerspective [get, set]

Get the camera type (1 - perspective, 0 - orthographic). (complementary value to "mOrthographic")

Parameters:

aPerspective

[out] Camera type (1 - perspective, 0 - orthographic)

 %% The following MATLAB code gets the type of the SurpassCamera object.
 aPerspective=vImarisApplication.mSurpassCamera.mPerspective
 aPerspective =
    1

Set the camera type (1 - perspective, 0 - orthographic) (complementary value to "mOrthographic")

Parameters:

aPerspective

[in] Camera type (1 - perspective, 0 - orthographic)

 %% The following MATLAB code sets the type of the SurpassCamera object to orthographic.
 vImarisApplication.mSurpassCamera.mPerspective=0;

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

Imaris.idl

ISurpassCamera Interface Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation