GMModelInterfaces Interface CATCGMPickOperatorPickedObject

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

interface CATCGMPickOperatorPickedObject

A picked object as computed by the picking operator CATCGMPickOperator.

Method Index

o GetDistanceFromRay(double&): Returns the distance of the object from the ray
o GetDistanceFromViewPoint(double&): Returns the distance of the object-ray intersection point from the view point.
o GetOwningBody(CATBody*&): Returns the CATBody that owns the picked geometry.
o GetPartId(void*&): Returns the associated PartId of the owning CATBody of the picked geometry.
o GetPickedGeometry(CATGeometry*&): Returns the picked geometry.

Methods

o GetDistanceFromRay

public virtual GetDistanceFromRay( oDistanceFromRay)

Returns the distance of the object from the ray

Parameters:

oDistanceFromRay: The distance from the ray to the object.

Returns:

S_OK on success or E_FAIL on failure.

o GetDistanceFromViewPoint

public virtual GetDistanceFromViewPoint( oDistanceFromViewPoint)

Returns the distance of the object-ray intersection point from the view point.

Parameters:

oDistanceFromViewPoint: The distance from the view point to the object.

Returns:

S_OK on success or E_FAIL on failure.

o GetOwningBody

public virtual GetOwningBody( oBody)

Returns the CATBody that owns the picked geometry. If picked geometry is a CATBody, the GetOwningBody will return the same

Parameters:

oBody: The CATBody that owns the picked geometry.

Returns:

S_OK on success or E_FAIL on failure.

o GetPartId

public virtual GetPartId( const oPartId)

Returns the associated PartId of the owning CATBody of the picked geometry.

Parameters:

oPartId: The part ID.

Returns:

S_OK on success or E_FAIL on failure.

o GetPickedGeometry

public virtual GetPickedGeometry( oGeometry)

Returns the picked geometry.

Parameters:

oGeometry: The picked geometry.

Returns:

S_OK on success or E_FAIL on failure.

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