All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUsePointOnPlane

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATIGSMUsePointOnPlane

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIGSMUsePointOnPlane

Interface to point on a plane feature.
Role: Allows you to access data of the point feature created on a plane with a reference point or not.

See also:: CATIGSMUseDirection
See also:: CATIGSMUseFactory.CreatePoint

Method Index

o GetCoordinates(CATICkeParm_var&,CATICkeParm_var&): Gets the X,Y cartesian coordinates in the plane.
o GetFirstDirection(CATIGSMUseDirection_var&): Gets the first direction on the plane to compute the point (for stability).
o GetProjectionSurface(CATIMmiMechanicalFeature_var&): Gets the Projection Surface to compute the point This data is not mandatory, if Projection Surface is null, the result is projection of the origin point or ref point on the plane is taken.
o GetReferencePoint(CATIMmiMechanicalFeature_var&): Gets the reference point.
o GetSecondDirection(CATMathDirection&): Gets the second direction on the plane to compute the point (for stability).
o GetSupport(CATIMmiMechanicalFeature_var&): Gets the support plane.
o SetCoordinates(CATICkeParm_var,CATICkeParm_var): Sets the X,Y cartesian coordinates in the plane.
o SetFirstDirection(CATIGSMUseDirection_var): Sets the first direction on the plane to compute the point (for stability).
o SetProjectionSurface(CATIMmiMechanicalFeature_var): Sets the Projection Surface to compute the point This data is not mandatory, if Projection Surface is null, the result is projection of the origin point or ref point on the plane is taken.
o SetReferencePoint(CATIMmiMechanicalFeature_var): Sets the reference point.
o SetSecondDirection(CATMathDirection&): Sets the second direction on the plane to compute the point (for stability).
o SetSupport(CATIMmiMechanicalFeature_var): Sets the support plane.

Methods

o GetCoordinates

public virtual HRESULT GetCoordinates(	CATICkeParm_var&	`oX`,
	CATICkeParm_var&	`oY`) = 0

Gets the X,Y cartesian coordinates in the plane.

Parameters:

oX: X coordinates
oY: Y coordinates

o GetFirstDirection

public virtual HRESULT GetFirstDirection( CATIGSMUseDirection_var& oDir) = 0

Gets the first direction on the plane to compute the point (for stability).

Parameters:

oDir: first direction

See also:

CATIGSMUseDirection

o GetProjectionSurface

public virtual HRESULT GetProjectionSurface( CATIMmiMechanicalFeature_var& oProjSur) = 0

Gets the Projection Surface to compute the point This data is not mandatory, if Projection Surface is null, the result is projection of the origin point or ref point on the plane is taken. (oProjSur = NULL_var is allowed).

Parameters:

oProjSur: Projection Surface

o GetReferencePoint

public virtual HRESULT GetReferencePoint( CATIMmiMechanicalFeature_var& oRefPoint) = 0

Gets the reference point. This data is not mandatory, if Point is null, the projection of the origin point on the plane is taken. (RefPoint = NULL_var is allowed).

Parameters:

oRefPoint: reference point

o GetSecondDirection

public virtual HRESULT GetSecondDirection( CATMathDirection& oDir) = 0

Gets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction

Parameters:

oDir: second direction

See also:

CATIGSMUseDirection

o GetSupport

public virtual HRESULT GetSupport( CATIMmiMechanicalFeature_var& oSupport) = 0

Gets the support plane.

Parameters:

oSupport: support

o SetCoordinates

public virtual HRESULT SetCoordinates(	const CATICkeParm_var	`iX`,
	const CATICkeParm_var	`iY`) = 0

Sets the X,Y cartesian coordinates in the plane.

Parameters:

iX: X coordinates
iY: Y coordinates

o SetFirstDirection

public virtual HRESULT SetFirstDirection( const CATIGSMUseDirection_var iDir) = 0

Sets the first direction on the plane to compute the point (for stability).

Parameters:

iDir: first direction

See also:

CATIGSMUseDirection

o SetProjectionSurface

public virtual HRESULT SetProjectionSurface( const CATIMmiMechanicalFeature_var iProjSur) = 0

Sets the Projection Surface to compute the point This data is not mandatory, if Projection Surface is null, the result is projection of the origin point or ref point on the plane is taken. (iProjSur = NULL_var is allowed).

Parameters:

iProjSur: Projection Surface

o SetReferencePoint

public virtual HRESULT SetReferencePoint( const CATIMmiMechanicalFeature_var iRefPoint) = 0

Sets the reference point. This data is not mandatory, if Point is null, the projection of the origin point on the plane is taken. (RefPoint = NULL_var is allowed).

Parameters:

iRefPoint: reference point

o SetSecondDirection

public virtual HRESULT SetSecondDirection( const CATMathDirection& iDir) = 0

Sets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction

Parameters:

iDir: second direction

See also:

CATIGSMUseDirection

o SetSupport

public virtual HRESULT SetSupport( const CATIMmiMechanicalFeature_var iSupport) = 0

Sets the support plane.

Parameters:

iSupport: support

This object is included in the file: CATIGSMUsePointOnPlane.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf