IClippingPlane Interface Reference

import "Imaris.idl";

Inheritance diagram for IClippingPlane:

Public Member Functions
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)

---

Detailed Description

The surpass clipping plane sections the world into two halves. One half of the world is hereby hidden. The clipping plane allows one to view the interior of a closed object.

---

Member Function Documentation

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

Return the orientation (axis/angle) of the Clipping Plane object.

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 Clipping Plane object.
 %% The Clipping Plane object is assumed to be selected in the Surpass Scene tree.
 aClippingPlane=vImarisApplication.mSurpassSelection;
 [aPositionX,aPositionY,aPositionZ,aAngle]=aClippingPlane.GetOrientationAxisAngle;
 

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

Return the orientation (quaternion) of the Clipping Plane object.

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 Clipping Plane object.
 %% The Clipping Plane object is assumed to be selected in the Surpass Scene tree.
 aClippingPlane=vImarisApplication.mSurpassSelection;
 [aQ0,aQ1,aQ2,aQ3]=aClippingPlane.GetOrientationQuaternion;
 

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

Return the center position of the Clipping Plane object.

Parameters:

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

 %% The following MATLAB code gets the center position of the Clipping Plane object.
 %% In this example, the IClippingPlane object is stored at position 4 in the Surpass scene (indexing starts at 0).
 aClippingPlane=vImarisApplication.mSurpassScene.GetChild(4);
 [aPositionX,aPositionY,aPositionZ]=aClippingPlane.GetPosition;
 

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

Set the orientation (axis/angle) of the Clipping Plane object.

Parameters:

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

 %% The following MATLAB code sets the orientation (axis/angle) of the Clipping Plane object.
 %% The Clipping Plane object is assumed to be selected in the Surpass Scene tree.
 aClippingPlane=vImarisApplication.mSurpassSelection;
 aClippingPlane.SetOrientationAxisAngle(100,100,20,0.57);
 

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

Sets the orientation (quaternion) of the Clipping Plane object.

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 Clipping Plane object.
 %% The Clipping Plane object is assumed to be selected in the Surpass Scene tree.
 aClippingPlane=vImarisApplication.mSurpassSelection;
 aClippingPlane.SetOrientationQuaternion(1.5,1.5,1.0,1.0);
 

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

Set the center position of the Clipping Plane object.

Parameters:

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

 %% The following MATLAB code sets the center position of the Clipping Plane object.
 %% In this example, the IClippingPlane object is stored at position 4 in the Surpass scene (indexing starts at 0).
 aClippingPlane=vImarisApplication.mSurpassScene.GetChild(4);
 aClippingPlane.SetPosition(100,100,20);
 

---

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

• Imaris.idl