#include <GePointOnSurface.h>

Inheritance diagram for OdGePointOnSurface:

Public Member Functions
	OdGePointOnSurface ()

	OdGePointOnSurface (const OdGePointOnSurface &source)

	OdGePointOnSurface (const OdGeSurface &surface)

	OdGePointOnSurface (const OdGeSurface &surface, const OdGePoint2d &param)

OdGePointOnSurface &	operator= (const OdGePointOnSurface &pntOnSurface)

const OdGeSurface *	surface () const

OdGePoint2d	parameter () const

OdGePoint3d	point () const

OdGePoint3d	point (const OdGePoint2d &param)

OdGePoint3d	point (const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector3d	normal () const

OdGeVector3d	normal (const OdGePoint2d &param)

OdGeVector3d	normal (const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector3d	uDeriv (int order) const

OdGeVector3d	uDeriv (int order, const OdGePoint2d &param)

OdGeVector3d	uDeriv (int order, const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector3d	vDeriv (int order) const

OdGeVector3d	vDeriv (int order, const OdGePoint2d &param)

OdGeVector3d	vDeriv (int order, const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector3d	mixedPartial () const

OdGeVector3d	mixedPartial (const OdGePoint2d &param)

OdGeVector3d	mixedPartial (const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector3d	tangentVector (const OdGeVector2d &vect) const

OdGeVector3d	tangentVector (const OdGeVector2d &vect, const OdGePoint2d &param)

OdGeVector3d	tangentVector (const OdGeVector2d &vect, const OdGeSurface &surface, const OdGePoint2d &param)

OdGeVector2d	inverseTangentVector (const OdGeVector3d &vect) const

OdGeVector2d	inverseTangentVector (const OdGeVector3d &vect, const OdGePoint2d &param)

OdGeVector2d	inverseTangentVector (const OdGeVector3d &vect, const OdGeSurface &surface, const OdGePoint2d &param)

OdGePointOnSurface &	setSurface (const OdGeSurface &surface)

OdGePointOnSurface &	setParameter (const OdGePoint2d &param)

Public Member Functions inherited from OdGePointEnt3d
OdGePoint3d	point3d () const

	operator OdGePoint3d () const

OdGePointEnt3d &	operator= (const OdGePointEnt3d &ent)

Public Member Functions inherited from OdGeEntity3d
	ODRX_HEAP_OPERATORS ()

	~OdGeEntity3d ()

bool	isKindOf (OdGe::EntityId entType) const

OdGe::EntityId	type () const

OdGeEntity3d *	copy () const

OdGeEntity3d &	operator= (const OdGeEntity3d &entity)

bool	operator== (const OdGeEntity3d &entity) const

bool	operator!= (const OdGeEntity3d &entity) const

bool	isEqualTo (const OdGeEntity3d &object, const OdGeTol &tol=OdGeContext::gTol) const

OdGeEntity3d &	transformBy (const OdGeMatrix3d &xfm)

OdGeEntity3d &	translateBy (const OdGeVector3d &translateVec)

OdGeEntity3d &	rotateBy (double angle, const OdGeVector3d &vect, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)

OdGeEntity3d &	mirror (const OdGePlane &plane)

OdGeEntity3d &	scaleBy (double scaleFactor, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)

bool	isOn (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const

Additional Inherited Members
Protected Member Functions inherited from OdGePointEnt3d
	OdGePointEnt3d ()

	OdGePointEnt3d (const OdGePointEnt3d &ent)

Protected Member Functions inherited from OdGeEntity3d
	OdGeEntity3d ()

	OdGeEntity3d (const OdGeEntity3d &)

void	connectTo (OdGeEntity3dImpl *)

Detailed Description

This class represents points on surfaces.

Corresponding C++ library: TD_Ge

Remarks: The point representation includes its parameter value, its coordinates, and the derivatives and normal of the surface at that point.

See also: <link ge_Evaluators, Working with Evaluator Classes>

Definition at line 47 of file GePointOnSurface.h.

Constructor & Destructor Documentation

◆ OdGePointOnSurface() [1/4]

OdGePointOnSurface::OdGePointOnSurface ( )

Default constructor for the OdGePointOnSurface class.

Remarks: The default constructor constructs a point on the surface OdGePlane::kXYPlane with a parameter value of (0.0, 0.0).

◆ OdGePointOnSurface() [2/4]

OdGePointOnSurface::OdGePointOnSurface ( const OdGePointOnSurface & source )

Copy constructor for the OdGePointOnSurface class.

Parameters

source [in] Object to be copied.

◆ OdGePointOnSurface() [3/4]

OdGePointOnSurface::OdGePointOnSurface ( const OdGeSurface & surface )

Constructor for the OdGePointOnSurface class.

Parameters

surface [in] Any surface on which this point lies.

Remarks: The constructor constructs a point that lies on a specified surface and has 0.0 for both U-axis and V-axis parameter values.

◆ OdGePointOnSurface() [4/4]

OdGePointOnSurface::OdGePointOnSurface	(	const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Constructor for the OdGePointOnSurface class.

Parameters

surface	[in] Any surface on which this point lies.
param	[in] Parameter value for this point.

Remarks: The constructor constructs a point that lies on a specified surface and has a specified parameter value for U-axis and V-axis.

Member Function Documentation

◆ inverseTangentVector() [1/3]

OdGeVector2d OdGePointOnSurface::inverseTangentVector ( const OdGeVector3d & vect ) const

Projects the specified vector to the tangent plane of the surface at the point corresponding to the parameter.

Parameters

vect	[in] Any 3D vector.

Remarks: Currently not implemented.

◆ inverseTangentVector() [2/3]

OdGeVector2d OdGePointOnSurface::inverseTangentVector	(	const OdGeVector3d &	vect,
		const OdGePoint2d &	param
	)

Projects the specified vector to the tangent plane of the surface at the point corresponding to the parameter.

Parameters

param	[in] Parameter to specify a point on surface.
vect	[in] Any 3D vector.

Remarks: Currently not implemented.

◆ inverseTangentVector() [3/3]

OdGeVector2d OdGePointOnSurface::inverseTangentVector	(	const OdGeVector3d &	vect,
		const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Projects the specified vector to the tangent plane of the surface at the point corresponding to the parameter

Parameters

surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.
vect	[in] Any 3D vector.

Remarks: Currently not implemented.

◆ mixedPartial() [1/3]

OdGeVector3d OdGePointOnSurface::mixedPartial ( ) const

Returns the mixed partial derivative of the surface at the point corresponding to the parameter.

Remarks: Currently not implemented.

◆ mixedPartial() [2/3]

OdGeVector3d OdGePointOnSurface::mixedPartial ( const OdGePoint2d & param )

Returns the mixed partial derivative of the surface at the point corresponding to the parameter.

Parameters

param [in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.; Currently not implemented.

◆ mixedPartial() [3/3]

OdGeVector3d OdGePointOnSurface::mixedPartial	(	const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Returns the mixed partial derivative of the surface at the point corresponding to the parameter.

Parameters

surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.; Currently not implemented.

◆ normal() [1/3]

OdGeVector3d OdGePointOnSurface::normal ( ) const

Returns the normal to the surface at the point corresponding to the parameter.

Remarks: Currently not implemented.

◆ normal() [2/3]

OdGeVector3d OdGePointOnSurface::normal ( const OdGePoint2d & param )

Returns the normal to the surface at the point corresponding to the parameter.

Parameters

param [in] Parameter to specify a point on surface.

Remarks: Specifying surface updates the underlying value.; Currently not implemented.

◆ normal() [3/3]

OdGeVector3d OdGePointOnSurface::normal	(	const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Returns the normal to the surface at the point corresponding to the parameter.

Parameters

surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.; Currently not implemented.

◆ operator=()

OdGePointOnSurface & OdGePointOnSurface::operator= ( const OdGePointOnSurface & pntOnSurface )

Assignment operator for the OdGePointOnSurface object.

Parameters

pntOnSurface [in] OdGePointOnSurface object to assign.

Returns: Reference to this OdGePointOnSurface object.

◆ parameter()

OdGePoint2d OdGePointOnSurface::parameter ( ) const

Returns the parameter value on the surface corresponding to the point.

◆ point() [1/3]

OdGePoint3d OdGePointOnSurface::point ( ) const

Returns the point on the surface corresponding to the parameter.

◆ point() [2/3]

OdGePoint3d OdGePointOnSurface::point ( const OdGePoint2d & param )

Returns the point on the surface corresponding to the parameter.

Parameters

param [in] Parameter to specify a point on surface.

Remarks: Specifying param updates the underlying value.

◆ point() [3/3]

OdGePoint3d OdGePointOnSurface::point	(	const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Returns the point on the surface corresponding to the parameter.

Parameters

surface	[in] Any surface on which this point lies.
param	[in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.

◆ setParameter()

OdGePointOnSurface & OdGePointOnSurface::setParameter ( const OdGePoint2d & param )

Sets the current parameter.

Parameters

param [in] Sets the current parameter.

◆ setSurface()

OdGePointOnSurface & OdGePointOnSurface::setSurface ( const OdGeSurface & surface )

Sets the current surface.

Parameters

surface [in] Any surface on which this point lies.

◆ surface()

const OdGeSurface * OdGePointOnSurface::surface ( ) const

Returns a pointer to a constant surface on which the point lies.

◆ tangentVector() [1/3]

OdGeVector3d OdGePointOnSurface::tangentVector ( const OdGeVector2d & vect ) const

Maps the specified vector to the tangent plane of the surface at the point corresponding to the parameter

Parameters

vect	[in] Any 2D vector.

Remarks

The tangent vector is mapped as follows:

    tangentVector = uDeriv(1) * vect.x + vDeriv(1) * vect.y

Currently not implemented.

◆ tangentVector() [2/3]

OdGeVector3d OdGePointOnSurface::tangentVector	(	const OdGeVector2d &	vect,
		const OdGePoint2d &	param
	)

Maps the specified vector to the tangent plane of the surface at the point corresponding to the parameter

Parameters

param	[in] Parameter to specify a point on surface.
vect	[in] Any 2D vector.

Remarks: Specifying param updates the underlying value.

The tangent vector is mapped as follows:

    tangentVector = uDeriv(1) * vect.x + vDeriv(1) * vect.y

Remarks: Currently not implemented.

◆ tangentVector() [3/3]

OdGeVector3d OdGePointOnSurface::tangentVector	(	const OdGeVector2d &	vect,
		const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Maps the specified vector to the tangent plane of the surface at the point corresponding to the parameter

Parameters

surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.
vect	[in] Any 2D vector.

Remarks: Specifying surface or param updates the underlying value.

The tangent vector is mapped as follows:

    tangentVector = uDeriv(1) * vect.x + vDeriv(1) * vect.y

Remarks: Currently not implemented.

◆ uDeriv() [1/3]

OdGeVector3d OdGePointOnSurface::uDeriv ( int order ) const

Returns the specified derivative of the surface in the U direction
at the point corresponding to the parameter.

Parameters

order [in] Specifies the order of the derivative [1-2].

Remarks: Currently not implemented.

◆ uDeriv() [2/3]

OdGeVector3d OdGePointOnSurface::uDeriv	(	int	order,
		const OdGePoint2d &	param
	)

Returns the specified derivative of the surface in the U direction
at the point corresponding to the parameter.

Parameters

order	[in] Specifies the order of the derivative [1-2].
param	[in] Parameter to specify a point on surface.

Remarks: Specifying param updates the underlying value.; Currently not implemented.

◆ uDeriv() [3/3]

OdGeVector3d OdGePointOnSurface::uDeriv	(	int	order,
		const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Returns the specified derivative of the surface in the U direction
at the point corresponding to the parameter.

Parameters

order	[in] Specifies the order of the derivative [1-2].
surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.; Currently not implemented.

◆ vDeriv() [1/3]

OdGeVector3d OdGePointOnSurface::vDeriv ( int order ) const

Returns the specified derivative of the surface in the V direction at the point corresponding to the parameter.

Parameters

order [in] Specifies the order of the derivative [1-2].

Remarks: Currently not implemented.

◆ vDeriv() [2/3]

OdGeVector3d OdGePointOnSurface::vDeriv	(	int	order,
		const OdGePoint2d &	param
	)

Returns the specified derivative of the surface in the V direction at the point corresponding to the parameter.

Parameters

order	[in] Specifies the order of the derivative [1-2].
param	[in] Parameter to specify a point on surface.

Remarks: Specifying param updates the underlying value.; Currently not implemented.

◆ vDeriv() [3/3]

OdGeVector3d OdGePointOnSurface::vDeriv	(	int	order,
		const OdGeSurface &	surface,
		const OdGePoint2d &	param
	)

Returns the specified derivative of the surface in the V direction at the point corresponding to the parameter.

Parameters

order	[in] Specifies the order of the derivative [1-2].
surface	[in] Any surface.
param	[in] Parameter to specify a point on surface.

Remarks: Specifying surface or param updates the underlying value.; Currently not implemented.

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

GePointOnSurface.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdGePointOnSurface() [1/4]

◆ OdGePointOnSurface() [2/4]

◆ OdGePointOnSurface() [3/4]

◆ OdGePointOnSurface() [4/4]

Member Function Documentation

◆ inverseTangentVector() [1/3]

◆ inverseTangentVector() [2/3]

◆ inverseTangentVector() [3/3]

◆ mixedPartial() [1/3]

◆ mixedPartial() [2/3]

◆ mixedPartial() [3/3]

◆ normal() [1/3]

◆ normal() [2/3]

◆ normal() [3/3]

◆ operator=()

◆ parameter()

◆ point() [1/3]

◆ point() [2/3]

◆ point() [3/3]

◆ setParameter()

◆ setSurface()

◆ surface()

◆ tangentVector() [1/3]

◆ tangentVector() [2/3]

◆ tangentVector() [3/3]

◆ uDeriv() [1/3]

◆ uDeriv() [2/3]

◆ uDeriv() [3/3]

◆ vDeriv() [1/3]

◆ vDeriv() [2/3]

◆ vDeriv() [3/3]