VisualizationFoundation class CATVisMeasurableGP

Usage: you must use this class as is. You should never derive it.

public class CATVisMeasurableGP

Class for measurement on Graphic Primitives.

Constructor and Destructor Index


o CATVisMeasurableGP(CATGraphicPrimitive*&)
Constructor.

Method Index


o GetCircle(CATMathPoint&,CATMathVector&,double&)
Retrieves the circle definition if the GP is a circle.
o GetCone(CATMathPoint&,CATMathVector&,double&)
Retrieves the cone definition if the GP is a cone.
o GetCylinder(CATMathPoint&,CATMathVector&,double&)
Retrieves the cylinder definition if the GP is a cylinder.
o GetLine(CATMathPoint&,CATMathPoint&)
Retrieves the line definition if the GP is a line.
o GetPlane(CATMathPlane&)
Retrieves the plane definition if the GP is a plane.
o GetSphere(CATMathPoint&,double&)
Retrieves the sphere definition if the GP is a sphere.
o GetTorus(CATMathPoint&,CATMathVector&,double&,double&)
Retrieves the torus definition if the GP is a torus.
o GetType(CATVisMeasurableType&)
Retrieves the type of the Graphic Primitive.
o SetCircle(CATMathPoint&,CATMathVector&,double&)
Defines the GP as a circle and sets the circle definition.
o SetCone(CATMathPoint&,CATMathVector&,double&)
Defines the GP as a cone and sets the cone definition.
o SetCylinder(CATMathPoint&,CATMathVector&,double&)
Defines the GP as a cylinder and sets the cylinder definition.
o SetLine(CATMathPoint&,CATMathPoint&)
Defines the GP as a line and sets the line definition.
o SetPlane(CATMathPlane&)
Defines the GP as a plane and sets the plane definition.
o SetSphere(CATMathPoint&,double&)
Defines the GP as a sphere and sets the sphere definition.
o SetTorus(CATMathPoint&,CATMathVector&,double&,double&)
Defines the GP as a torus and sets the torus definition.
o SetUnknown()
Defines the GP as an unknown geometry.

Constructor and Destructor


o CATVisMeasurableGP
public CATVisMeasurableGP(CATGraphicPrimitive*& ipGP)
Constructor.
Parameters:
ipGP
The graphic primitive to use for setting / getting measurement properties.

Methods


o GetCircle
public HRESULT GetCircle(CATMathPoint& ioCenter,
CATMathVector& ioAxis,
double& oRadius)
Retrieves the circle definition if the GP is a circle.
Parameters:
ioCenter
The center point.
ioAxis
The axis.
oRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetCone
public HRESULT GetCone(CATMathPoint& ioApex,
CATMathVector& ioAxis,
double& oSemiAngle)
Retrieves the cone definition if the GP is a cone.
Parameters:
ioApex
The apex point.
ioAxis
The axis.
oSemiAngle
The semi-angle.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetCylinder
public HRESULT GetCylinder(CATMathPoint& ioPoint,
CATMathVector& ioAxis,
double& oRadius)
Retrieves the cylinder definition if the GP is a cylinder.
Parameters:
ioPoint
The point.
ioAxis
The axis.
oRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetLine
public HRESULT GetLine(CATMathPoint& ioSttPoint,
CATMathPoint& ioEndPoint)
Retrieves the line definition if the GP is a line.
Parameters:
ioSttPoint
The start point.
ioEndPoint
The end point.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetPlane
public HRESULT GetPlane(CATMathPlane& ioPlane)
Retrieves the plane definition if the GP is a plane.
Parameters:
ioPlane
The plane.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetSphere
public HRESULT GetSphere(CATMathPoint& ioCenter,
double& oRadius)
Retrieves the sphere definition if the GP is a sphere.
Parameters:
ioCenter
The center point.
oRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetTorus
public HRESULT GetTorus(CATMathPoint& ioPoint,
CATMathVector& ioAxis,
double& oMajorRadius,
double& oMinorRadius)
Retrieves the torus definition if the GP is a torus.
Parameters:
ioPoint
The point.
ioAxis
The axis.
oMajorRadius
The major radius.
oMinorRadius
The minor radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o GetType
public HRESULT GetType(CATVisMeasurableType& oType)
Retrieves the type of the Graphic Primitive.
Parameters:
oType
The
CATVisMeasurableType of the GraphicPrimitive.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetCircle
public HRESULT SetCircle(CATMathPoint& iCenter,
CATMathVector& iAxis,
double& iRadius)
Defines the GP as a circle and sets the circle definition.
Parameters:
iCenter
The center point.
iAxis
The axis.
iRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetCone
public HRESULT SetCone(CATMathPoint& iApex,
CATMathVector& iAxis,
double& iSemiAngle)
Defines the GP as a cone and sets the cone definition.
Parameters:
iApex
The apex point.
iAxis
The axis.
iSemiAngle
The semi-angle.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetCylinder
public HRESULT SetCylinder(CATMathPoint& iPoint,
CATMathVector& iAxis,
double& iRadius)
Defines the GP as a cylinder and sets the cylinder definition.
Parameters:
iPoint
The point.
iAxis
The axis.
iRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetLine
public HRESULT SetLine(CATMathPoint& iSttPoint,
CATMathPoint& iEndPoint)
Defines the GP as a line and sets the line definition.
Parameters:
iSttPoint
The start point.
iEndPoint
The end point.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetPlane
public HRESULT SetPlane(CATMathPlane& iPlane)
Defines the GP as a plane and sets the plane definition.
Parameters:
iPlane
The plane.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetSphere
public HRESULT SetSphere(CATMathPoint& iCenter,
double& iRadius)
Defines the GP as a sphere and sets the sphere definition.
Parameters:
iCenter
The center point.
iRadius
The radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetTorus
public HRESULT SetTorus(CATMathPoint& iPoint,
CATMathVector& iAxis,
double& iMajorRadius,
double& iMinorRadius)
Defines the GP as a torus and sets the torus definition.
Parameters:
iPoint
The point.
iAxis
The axis.
iMajorRadius
The major radius.
iMinorRadius
The minor radius.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetUnknown
public HRESULT SetUnknown()
Defines the GP as an unknown geometry.
Returns:
S_OK if everything went fine, E_FAIL otherwise
This object is included in the file: CATVisMeasurableGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.