#include <DbGripPoints.h>

Inheritance diagram for OdDbGripPointsPE:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbGripPointsPE)

virtual OdResult	getGripPoints (const OdDbEntity *pEntity, OdGePoint3dArray &gripPoints) const

virtual OdResult	moveGripPointsAt (OdDbEntity *pEntity, const OdIntArray &indices, const OdGeVector3d &offset)

virtual OdResult	getGripPoints (const OdDbEntity *pEntity, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const

virtual OdResult	moveGripPointsAt (OdDbEntity *pEntity, const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)

virtual OdResult	getStretchPoints (const OdDbEntity *pEntity, OdGePoint3dArray &stretchPoints) const

virtual OdResult	moveStretchPointsAt (OdDbEntity *pEntity, const OdIntArray &indices, const OdGeVector3d &offset)

virtual OdResult	getOsnapPoints (const OdDbEntity *pEntity, OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const

virtual OdResult	getOsnapPoints (const OdDbEntity *pEntity, OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insert) const

virtual OdResult	getGripPointsAtSubentPath (const OdDbEntity *pEntity, const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const

virtual OdResult	moveGripPointsAtSubentPaths (OdDbEntity *pEntity, const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class is the Grip Points Protocol Extension class.

See also: TD_Db

Definition at line 43 of file DbGripPoints.h.

Member Function Documentation

◆ getGripPoints() [1/2]

virtual OdResult OdDbGripPointsPE::getGripPoints	(	const OdDbEntity *	pEntity,
		OdDbGripDataPtrArray &	grips,
		const double	curViewUnitSize,
		const int	gripSize,
		const OdGeVector3d &	curViewDir,
		const int	bitFlags
	)		const

virtual

Returns OdDbGripData objects for grip points of this entity.

Parameters

pEntity	[in] Pointer to the entity.
grips	[in/out] Receives an array of OdDbGripData objects.

Remarks: Grip points are appended to the specified array. When eNotImplemented is returned, the application should call the other overload of the getGripPoints() method. The default implementation of this function returns eNotImplemented.

◆ getGripPoints() [2/2]

virtual OdResult OdDbGripPointsPE::getGripPoints	(	const OdDbEntity *	pEntity,
		OdGePoint3dArray &	gripPoints
	)		const

virtual

Returns all grip points of the specified entity.

Parameters

pEntity	[in] Pointer to the entity.
gripPoints	[in/out] Receives an array of WCS grip points.

Remarks: Grip points are appended to the specified array.

Returns: Returns eOk if successful, or an appropriate error code if not. The default implementation of this function returns eNotImplemented.

◆ getGripPointsAtSubentPath()

virtual OdResult OdDbGripPointsPE::getGripPointsAtSubentPath	(	const OdDbEntity *	pEntity,
		const OdDbFullSubentPath &	path,
		OdDbGripDataPtrArray &	grips,
		const double	curViewUnitSize,
		const int	gripSize,
		const OdGeVector3d &	curViewDir,
		const OdUInt32	bitflags
	)		const

virtual

Gets the grip points and supporting information about the grips for a subentity.

Parameters

pEntity	[in] Pointer to the entity.
path	[in] The OdDbFullSubentPath to the subentity.
grips	[in/out] Receives an array of pointers of OdDbGripData objects, one object for each grip point in the subentity.
curViewUnitSize	[in] The size (in pixels) of one drawing unit in the current viewport.
gripSize	[in] The current grip size (in pixels).
curViewDir	[in] The view direction in the current viewport.
bitflags	[in] The bitmap of one or more flags specified by the GetGripPointsFlags enumeration.

◆ getOsnapPoints() [1/2]

virtual OdResult OdDbGripPointsPE::getOsnapPoints	(	const OdDbEntity *	pEntity,
		OdDb::OsnapMode	osnapMode,
		OdGsMarker	gsSelectionMark,
		const OdGePoint3d &	pickPoint,
		const OdGePoint3d &	lastPoint,
		const OdGeMatrix3d &	xWorldToEye,
		OdGePoint3dArray &	snapPoints
	)		const

virtual

Returns all appropriate object snap points of the specified entity.

Parameters

pEntity	[in] Pointer to the entity.
osnapMode	[in] The object snap mode being queried.
gsSelectionMark	[in] The GS marker of the subentity being queried.
pickPoint	[in] The WCS point being queried.
lastPoint	[in] The WCS point picked before pickPoint.
viewXform	[in] The WCS->DCS transformation matrix.
ucs	[in] The WCS->UCS transformation matrix.
snapPoints	[in/out] Receives an array of UCS object snap points.

Remarks: Object snap points are appended to the specified array.

osnapMode must be one of the following:

Value Description OdDb::kOsModeEnd 1 Endpoint OdDb::kOsModeMid 2 Midpoint OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Unknown

The default implementation of this function returns eNotImplemented.

◆ getOsnapPoints() [2/2]

virtual OdResult OdDbGripPointsPE::getOsnapPoints	(	const OdDbEntity *	pEntity,
		OdDb::OsnapMode	osnapMode,
		OdGsMarker	gsSelectionMark,
		const OdGePoint3d &	pickPoint,
		const OdGePoint3d &	lastPoint,
		const OdGeMatrix3d &	xWorldToEye,
		OdGePoint3dArray &	snapPoints,
		const OdGeMatrix3d &	insert
	)		const

virtual

Returns all appropriate object snap points of the specified entity.

Parameters

pEntity	[in] Pointer to the entity.
osnapMode	[in] The object snap mode being queried.
gsSelectionMark	[in] The GS marker of the subentity being queried.
pickPoint	[in] The WCS point being queried.
lastPoint	[in] The WCS point picked before pickPoint.
viewXform	[in] The WCS->DCS transformation matrix.
ucs	[in] The WCS->UCS transformation matrix.
snapPoints	[in/out] Receives an array of UCS object snap points.
insert	[in] Current insertion matrix

Remarks: Object snap points are appended to the specified array.

osnapMode must be one of the following:

Value Description OdDb::kOsModeEnd 1 Endpoint OdDb::kOsModeMid 2 Midpoint OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Unknown

The default implementation of this function returns eNotImplemented.

◆ getStretchPoints()

virtual OdResult OdDbGripPointsPE::getStretchPoints	(	const OdDbEntity *	pEntity,
		OdGePoint3dArray &	stretchPoints
	)		const

virtual

Returns all stretch points of the specified entity.

Parameters

pEntity	[in] Pointer to the entity.
stretchPoints	[in/out] Receives an array of WCS stretch points.

Remarks: Stretch points are appended to the specified array.

Returns eOk if successful, or an appropriate error code if not. The default implementation of this function returns eNotImplemented.

◆ moveGripPointsAt() [1/2]

virtual OdResult OdDbGripPointsPE::moveGripPointsAt	(	OdDbEntity *	pEntity,
		const OdDbVoidPtrArray &	grips,
		const OdGeVector3d &	offset,
		int	bitFlags
	)

virtual

Moves the specified grip points of this entity.

Parameters

pEntity	[in] Pointer to the entity.
grips	[in] Array of OdDbGripData identifiers.
offset	[in] The direction and magnitude of the grip points offset (WCS).

Remarks: The default implementation of this function returns eNotImplemented.

◆ moveGripPointsAt() [2/2]

virtual OdResult OdDbGripPointsPE::moveGripPointsAt	(	OdDbEntity *	pEntity,
		const OdIntArray &	indices,
		const OdGeVector3d &	offset
	)

virtual

Moves the specified grip points of the specified entity.

Parameters

pEntity	[in] Pointer to the entity.
indices	[in] Array of indicies.
offset	[in] The direction and magnitude of the grip points offset (WCS).

Remarks: Each element in gripPoints has a corresponding entry in indices, which specifies the index of the grip point as returned by getGripPoints.

Returns: Returns eOk if successful, or an appropriate error code if not. The default implementation of this function returns eNotImplemented.

◆ moveGripPointsAtSubentPaths()

virtual OdResult OdDbGripPointsPE::moveGripPointsAtSubentPaths	(	OdDbEntity *	pEntity,
		const OdDbFullSubentPathArray &	paths,
		const OdDbVoidPtrArray &	gripAppData,
		const OdGeVector3d &	offset,
		const OdUInt32	bitflags
	)

virtual

Applies a vector offset to one or more grip points exposed by subentities on the object.

Parameters

pEntity	[in] Pointer to the entity.
paths	[in] The array of OdDbFullSubentPath objects.
gripAppData	[in] The array of pointers of OdDbGripData objects.
offset	[in] The vector (in WCS coordinates) indicating the direction and magnitude of the translation.
bitflags	[in] The bitmap of one or more flags specified by the GetGripPointsFlags enumeration.

◆ moveStretchPointsAt()

virtual OdResult OdDbGripPointsPE::moveStretchPointsAt	(	OdDbEntity *	pEntity,
		const OdIntArray &	indices,
		const OdGeVector3d &	offset
	)

virtual

Moves the specified stretch points of this entity.

Parameters

pEntity	[in] Pointer to the entity.
indices	[in] Array of indicies.
offset	[in] The direction and magnitude of the stretch points offset (WCS).

Remarks: Each element in stretchPoints has a corresponding entry in indices, which specifies the index of the stretch point as returned by getStretchPoints.

Returns eOk if successful, or an appropriate error code if not. The default implementation of this function returns eNotImplemented.

◆ ODRX_DECLARE_MEMBERS()

OdDbGripPointsPE::ODRX_DECLARE_MEMBERS ( OdDbGripPointsPE )

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

DbGripPoints.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getGripPoints() [1/2]

◆ getGripPoints() [2/2]

◆ getGripPointsAtSubentPath()

◆ getOsnapPoints() [1/2]

◆ getOsnapPoints() [2/2]

◆ getStretchPoints()

◆ moveGripPointsAt() [1/2]

◆ moveGripPointsAt() [2/2]

◆ moveGripPointsAtSubentPaths()

◆ moveStretchPointsAt()

◆ ODRX_DECLARE_MEMBERS()