#include <DbHelix.h>

Inheritance diagram for OdDbHelix:

Public Types
enum	ConstrainType { kTurnHeight = 0 , kTurns = 1 , kHeight = 2 }

Public Types inherited from OdDbSpline
enum	SplineType { kFitPoints = 0 , kControlPoints = 1 }

Public Types inherited from OdDbEntity
enum	VisualStyleType { kFullVisualStyle , kFaceVisualStyle , kEdgeVisualStyle }

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 , kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 , kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 , kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 , kLastFlag = kDrawableNotPlottable }

enum	DrawableType { kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 , kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground , kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground , kImageBasedLightingBackground }

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbHelix)

	OdDbHelix ()

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	subExplode (OdRxObjectPtrArray &entitySet) const

virtual OdResult	subTransformBy (const OdGeMatrix3d &xfm)

void	createHelix ()

OdGePoint3d	axisPoint () const

void	setAxisPoint (const OdGePoint3d &axisPoint, bool bMoveStartPoint=true)

OdGePoint3d	startPoint () const

void	setStartPoint (const OdGePoint3d &startPoint)

OdGeVector3d	axisVector () const

void	setAxisVector (const OdGeVector3d &axisVector)

double	height () const

void	setHeight (double dHeight)

double	baseRadius () const

void	setBaseRadius (double dRadius)

double	topRadius () const

void	setTopRadius (double dRadius)

double	turns () const

void	setTurns (double dTurns)

double	turnHeight () const

void	setTurnHeight (double dTurnHeight)

bool	twist () const

void	setTwist (bool bTwist)

ConstrainType	constrain () const

void	setConstrain (ConstrainType constrain)

double	turnSlope () const

double	totalLength () const

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdResult	reverseCurve ()

Public Member Functions inherited from OdDbSpline
	ODDB_DECLARE_MEMBERS (OdDbSpline)

	OdDbSpline ()

bool	isRational () const

int	degree () const

void	elevateDegree (int newDegree)

int	numControlPoints () const

void	getControlPointAt (int controlPointIndex, OdGePoint3d &point) const

void	setControlPointAt (int controlPointIndex, const OdGePoint3d &point)

int	numFitPoints () const

OdResult	getFitPointAt (int fitPointIndex, OdGePoint3d &point) const

void	setFitPointAt (int fitPointIndex, const OdGePoint3d &point)

void	insertFitPointAt (int fitPointIndex, const OdGePoint3d &point)

void	removeFitPointAt (int fitPointIndex)

double	fitTolerance () const

void	setFitTol (double fitTolerance)

OdResult	getFitTangents (OdGeVector3d &startTangent, OdGeVector3d &endTangent) const

void	setFitTangents (const OdGeVector3d &startTangent, const OdGeVector3d &endTangent)

bool	hasFitData () const

OdResult	getFitData (OdGePoint3dArray &fitPoints, int &degree, double &fitTolerance, bool &tangentsExist, OdGeVector3d &startTangent, OdGeVector3d &endTangent) const

OdResult	getFitData (OdGePoint3dArray &fitPoints, int &degree, double &fitTolerance, bool &tangentsExist, OdGeVector3d &startTangent, OdGeVector3d &endTangent, OdGe::OdGeKnotParameterization &knotParam) const

void	setFitData (const OdGePoint3dArray &fitPoints, int degree, double fitTolerance, const OdGeVector3d &startTangent, const OdGeVector3d &endTangent)

void	setFitData (const OdGePoint3dArray &fitPoints, int degree, double fitTolerance, const OdGeVector3d &startTangent, const OdGeVector3d &endTangent, OdGe::OdGeKnotParameterization knotParam)

void	purgeFitData ()

void	getNurbsData (int &degree, bool &rational, bool &closed, bool &periodic, OdGePoint3dArray &controlPoints, OdGeDoubleArray &knots, OdGeDoubleArray &weights, double &controlPtTol, double &knotTol) const

void	getNurbsData (int &degree, bool &rational, bool &closed, bool &periodic, OdGePoint3dArray &controlPoints, OdGeKnotVector &knots, OdGeDoubleArray &weights, double &controlPtTol) const

void	setNurbsData (int degree, bool rational, bool closed, bool periodic, const OdGePoint3dArray &controlPoints, const OdGeDoubleArray &knots, const OdGeDoubleArray &weights, double controlPtTol, double knotTol)

void	setNurbsData (int degree, bool rational, bool closed, bool periodic, const OdGePoint3dArray &controlPoints, const OdGeKnotVector &knots, const OdGeDoubleArray &weights, double controlPtTol)

double	weightAt (int weightIndex) const

void	setWeightAt (int weightIndex, double weight)

void	insertKnot (double param)

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual OdResult	subGetGeomExtents (OdGeExtents3d &extents) const

virtual bool	isPlanar () const

virtual OdResult	getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const

virtual OdResult	getPointAtParam (double param, OdGePoint3d &pointOnCurve) const

virtual OdResult	getParamAtPoint (const OdGePoint3d &pointOnCurve, double &param) const

virtual OdResult	getStartParam (double &startParam) const

virtual OdResult	getEndParam (double &endParam) const

virtual OdResult	getStartPoint (OdGePoint3d &startPoint) const

virtual OdResult	getEndPoint (OdGePoint3d &endPoint) const

virtual OdResult	getDistAtParam (double param, double &dist) const

virtual OdResult	getParamAtDist (double dist, double &param) const

virtual OdResult	getFirstDeriv (double param, OdGeVector3d &firstDeriv) const

virtual OdResult	getSecondDeriv (double param, OdGeVector3d &secondDeriv) const

virtual OdResult	getArea (double &area) const

	TD_USING (OdDbCurve::getFirstDeriv)

	TD_USING (OdDbCurve::getSecondDeriv)

virtual OdResult	getSplitCurves (const OdGeDoubleArray &params, OdRxObjectPtrArray &entitySet) const

	TD_USING (OdDbCurve::getSplitCurves)

OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

SplineType	type () const

OdResult	setType (SplineType type)

bool	cvFrame () const

void	setCvFrame (bool bVisible)

OdResult	insertControlPointAt (double knotParam, const OdGePoint3d &ctrlPt, double weight=1.0)

OdResult	removeControlPointAt (int index)

bool	isNull () const

bool	modifyPositionAndTangent (double param, const OdGePoint3d &point, const OdGeVector3d *deriv)

virtual OdResult	getOdGeCurve (OdGeCurve3d *&pGeCurve, const OdGeTol &tol=OdGeContext::gTol) const

virtual OdResult	setFromOdGeCurve (const OdGeCurve3d &geCurve, OdGeVector3d *normal=NULL, const OdGeTol &tol=OdGeContext::gTol)

Public Member Functions inherited from OdDbCurve
	ODDB_DECLARE_MEMBERS (OdDbCurve)

	OdDbCurve ()

virtual bool	isClosed () const

virtual bool	isPeriodic () const

virtual OdResult	getDistAtPoint (const OdGePoint3d &pointOnCurve, double &dist) const

virtual OdResult	getPointAtDist (double dist, OdGePoint3d &pointOnCurve) const

virtual OdResult	getFirstDeriv (const OdGePoint3d &pointOnCurve, OdGeVector3d &firstDeriv) const

virtual OdResult	getSecondDeriv (const OdGePoint3d &pointOnCurve, OdGeVector3d &secondDeriv) const

virtual OdResult	getClosestPointTo (const OdGePoint3d &givenPoint, OdGePoint3d &pointOnCurve, bool extend=false) const

virtual OdResult	getClosestPointTo (const OdGePoint3d &givenPoint, const OdGeVector3d &normal, OdGePoint3d &pointOnCurve, bool extend=false) const

virtual OdResult	getSpline (OdDbSplinePtr *spline) const

virtual OdResult	extend (double param)

virtual OdResult	extend (bool extendStart, const OdGePoint3d &toPoint)

virtual OdResult	getOrthoProjectedCurve (const OdGePlane &projPlane, OdDbCurvePtr *pProjCurve) const

virtual OdResult	getProjectedCurve (const OdGePlane &projPlane, const OdGeVector3d &projDirection, OdDbCurvePtr *pProjCurve) const

virtual OdResult	getOffsetCurves (double offsetDistance, OdRxObjectPtrArray &offsetCurves) const

virtual OdResult	getOffsetCurvesGivenPlaneNormal (const OdGeVector3d &normal, double offsetDistance, OdRxObjectPtrArray &offsetCurves) const

virtual OdResult	getSplitCurves (const OdGePoint3dArray &points, OdRxObjectPtrArray &curveSegments) const

virtual OdInt32	findVertexIndex (const OdDbVertex *vert) const

Public Member Functions inherited from OdDbEntity
	ODDB_DECLARE_MEMBERS (OdDbEntity)

	OdDbEntity ()

OdDbObjectId	blockId () const

OdCmColor	color () const

virtual OdResult	setColor (const OdCmColor &color, bool doSubents=true)

OdUInt16	colorIndex () const

virtual OdCmEntityColor	entityColor () const

virtual OdResult	setColorIndex (OdUInt16 colorIndex, bool doSubents=true)

OdDbObjectId	colorId () const

virtual OdResult	setColorId (OdDbObjectId colorId, bool doSubents=true)

OdCmTransparency	transparency () const

virtual OdResult	setTransparency (const OdCmTransparency &transparency, bool doSubents=true)

OdString	plotStyleName () const

OdDb::PlotStyleNameType	getPlotStyleNameId (OdDbObjectId &plotStyleNameId) const

virtual OdResult	setPlotStyleName (const OdString &plotStyleName, bool doSubents=true)

virtual OdResult	setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbObjectId plotStyleNameId=OdDbObjectId::kNull, bool doSubents=true)

OdString	layer () const

OdDbObjectId	layerId () const

virtual OdResult	setLayer (const OdString &layerName, bool doSubents=true, bool allowHiddenLayer=false)

virtual OdResult	setLayer (OdDbObjectId layerId, bool doSubents=true, bool allowHiddenLayer=false)

OdString	linetype () const

OdDbObjectId	linetypeId () const

virtual OdResult	setLinetype (const OdString &linetypeName, bool doSubents=true)

virtual OdResult	setLinetype (OdDbObjectId linetypeID, bool doSubents=true)

OdString	material () const

OdDbObjectId	materialId () const

virtual OdResult	setMaterial (const OdString &materialName, bool doSubents=true)

virtual OdResult	setMaterial (OdDbObjectId materialID, bool doSubents=true)

OdDbObjectId	visualStyleId (VisualStyleType vstype=kFullVisualStyle) const

virtual OdResult	setVisualStyle (OdDbObjectId visualStyleId, VisualStyleType vstype=kFullVisualStyle, bool doSubents=true)

virtual const OdGiMapper *	materialMapper () const

virtual void	setMaterialMapper (const OdGiMapper *mapper, bool doSubents=true)

double	linetypeScale () const

virtual OdResult	setLinetypeScale (double linetypeScale, bool doSubents=true)

OdDb::Visibility	visibility () const

ODRX_SEALED_VIRTUAL OdResult	setVisibility (OdDb::Visibility visibility, bool doSubents=true) ODRX_SEALED

OdDb::Visibility	tempVisibility () const

void	setTempVisibility (OdDb::Visibility visibility)

OdDb::LineWeight	lineWeight () const

virtual OdResult	setLineWeight (OdDb::LineWeight lineWeight, bool doSubents=true)

virtual bool	castShadows () const

virtual void	setCastShadows (bool castShadows)

virtual bool	receiveShadows () const

virtual void	setReceiveShadows (bool receiveShadows)

virtual OdDb::CollisionType	collisionType () const

void	setPropertiesFrom (const OdDbEntity *pSource, bool doSubents=true)

void	subHandOverTo (OdDbObject *pNewObject)

ODRX_SEALED_VIRTUAL OdResult	transformBy (const OdGeMatrix3d &xfm) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	explode (OdRxObjectPtrArray &entitySet) const ODRX_SEALED

virtual OdResult	explodeToBlock (OdDbBlockTableRecord pBlockRecord, OdDbObjectIdArray ids=0)

virtual OdResult	explodeGeometry (OdRxObjectPtrArray &entitySet) const

virtual OdResult	explodeGeometryToBlock (OdDbBlockTableRecord pBlockRecord, OdDbObjectIdArray ids=0)

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

void	setDatabaseDefaults (OdDbDatabase *pDb=0, bool doSubents=false)

virtual void	subSetDatabaseDefaults (OdDbDatabase *pDb, bool doSubents)

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual void	subList () const

void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual OdResult	subErase (bool erasing) ODRX_OVERRIDE

void	recordGraphicsModified (bool graphicsModified=true)

virtual void	copyFrom (const OdRxObject *pSource)

ODRX_SEALED_VIRTUAL void	list () const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	highlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	isContentSnappable () const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getGripPoints (OdGePoint3dArray &gripPoints) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	moveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	moveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getStretchPoints (OdGePoint3dArray &stretchPoints) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	moveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED

virtual void	dragStatus (const OdDb::DragStat status)

ODRX_SEALED_VIRTUAL void	gripStatus (const OdDb::GripStat status) ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	cloneMeForDragging () ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	hideMeForDragging () const ODRX_SEALED

virtual void	saveAs (OdGiWorldDraw *pWd, OdDb::DwgVersion ver) const

ODRX_SEALED_VIRTUAL OdResult	getCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED

OdResult	boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const

OdResult	boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const

ODRX_SEALED_VIRTUAL OdResult	getSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	moveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	deleteSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	addSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbEntityPtr	subentPtr (const OdDbFullSubentPath &path) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	transformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getSubentClassId (const OdDbFullSubentPath &path, void *clsId) ODRX_SEALED

ODRX_SEALED_VIRTUAL OdResult	getSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) ODRX_SEALED

ODRX_SEALED_VIRTUAL void	subentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity) ODRX_SEALED

virtual OdGeMatrix3d	getEcs () const

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

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

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

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

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdDbCurve
static OdResult	createFromOdGeCurve (const OdGeCurve3d &geCurve, OdDbCurve &pDbCurve, OdGeVector3d normal=NULL, const OdGeTol &tol=OdGeContext::gTol)

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

static OdRxClass *	desc ()

Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

virtual OdResult	subGetTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const

virtual OdResult	subGetCompoundObjectTransform (OdGeMatrix3d &xM) const

virtual bool	subCloneMeForDragging ()

virtual bool	subHideMeForDragging () const

virtual void	subGripStatus (const OdDb::GripStat status)

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

virtual OdResult	subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const

virtual bool	subIsContentSnappable () const

virtual OdResult	subGetGripPoints (OdGePoint3dArray &gripPoints) const

virtual OdResult	subMoveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)

virtual OdResult	subGetGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const

virtual OdResult	subMoveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)

virtual OdResult	subGetStretchPoints (OdGePoint3dArray &stretchPoints) const

virtual OdResult	subMoveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)

virtual OdResult	subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const

virtual OdResult	subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const

virtual void	subHighlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const

virtual OdDb::Visibility	subVisibility () const

virtual OdResult	subSetVisibility (OdDb::Visibility visibility, bool doSubents=true)

virtual OdResult	subDeleteSubentPaths (const OdDbFullSubentPathArray &paths)

virtual OdResult	subAddSubentPaths (const OdDbFullSubentPathArray &paths)

virtual OdResult	subMoveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)

virtual OdResult	subGetGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const

virtual OdResult	subGetSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const

virtual OdResult	subGetGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const

virtual OdDbEntityPtr	subSubentPtr (const OdDbFullSubentPath &path) const

virtual OdResult	subTransformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform)

virtual OdResult	subGetSubentClassId (const OdDbFullSubentPath &path, void *clsId) const

virtual OdResult	subGetSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) const

virtual void	subSubentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity)

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

This class represents Helix entities in an OdDbDatabase instance.

Corresponding C++ library: TD_Db

Definition at line 41 of file DbHelix.h.

Member Enumeration Documentation

◆ ConstrainType

enum OdDbHelix::ConstrainType

Enumerator
kTurnHeight
kTurns
kHeight

Definition at line 48 of file DbHelix.h.

Constructor & Destructor Documentation

◆ OdDbHelix()

OdDbHelix::OdDbHelix ( )

Member Function Documentation

◆ axisPoint()

OdGePoint3d OdDbHelix::axisPoint ( ) const

◆ axisVector()

OdGeVector3d OdDbHelix::axisVector ( ) const

◆ baseRadius()

double OdDbHelix::baseRadius ( ) const

◆ constrain()

ConstrainType OdDbHelix::constrain ( ) const

◆ createHelix()

void OdDbHelix::createHelix ( )

◆ dwgInFields()

virtual OdResult OdDbHelix::dwgInFields ( OdDbDwgFiler * pFiler )

virtual

Reads the .dwg file data of this object.

Parameters

pFiler [in] Filer object from which data are read.

Returns: Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbSpline.

◆ dwgOutFields()

virtual void OdDbHelix::dwgOutFields ( OdDbDwgFiler * pFiler ) const

virtual

Writes the .dwg file data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are written.

Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbSpline.

◆ dxfInFields()

virtual OdResult OdDbHelix::dxfInFields ( OdDbDxfFiler * pFiler )

virtual

Reads the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer from which data are read.

Returns: Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbSpline.

◆ dxfOutFields()

virtual void OdDbHelix::dxfOutFields ( OdDbDxfFiler * pFiler ) const

virtual

Writes the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are to be written.

Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbSpline.

◆ height()

double OdDbHelix::height ( ) const

◆ ODDB_DECLARE_MEMBERS()

OdDbHelix::ODDB_DECLARE_MEMBERS ( OdDbHelix )

◆ reverseCurve()

virtual OdResult OdDbHelix::reverseCurve ( )

virtual

Reverses this Spline entity.

Remarks: The start point becomes the end point, and vice versa.

Reimplemented from OdDbSpline.

◆ setAxisPoint()

void OdDbHelix::setAxisPoint	(	const OdGePoint3d &	axisPoint,
		bool	bMoveStartPoint = `true`
	)

◆ setAxisVector()

void OdDbHelix::setAxisVector ( const OdGeVector3d & axisVector )

◆ setBaseRadius()

void OdDbHelix::setBaseRadius ( double dRadius )

◆ setConstrain()

void OdDbHelix::setConstrain ( ConstrainType constrain )

◆ setHeight()

void OdDbHelix::setHeight ( double dHeight )

◆ setStartPoint()

void OdDbHelix::setStartPoint ( const OdGePoint3d & startPoint )

◆ setTopRadius()

void OdDbHelix::setTopRadius ( double dRadius )

◆ setTurnHeight()

void OdDbHelix::setTurnHeight ( double dTurnHeight )

◆ setTurns()

void OdDbHelix::setTurns ( double dTurns )

◆ setTwist()

void OdDbHelix::setTwist ( bool bTwist )

◆ startPoint()

OdGePoint3d OdDbHelix::startPoint ( ) const

◆ subExplode()

virtual OdResult OdDbHelix::subExplode ( OdRxObjectPtrArray & entitySet ) const

virtual

Explodes this entity into a set of simpler entities.

Parameters

entitySet [in/out] Receives an array of pointers to the new entities.

Returns: Returns eOk if successful, or an appropriate error code if not.

Remarks: Entities resulting from the explosion are appended to the specified array.

The newly created entities are not database resident.

The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.

Reimplemented from OdDbSpline.

◆ subGetClassID()

virtual OdResult OdDbHelix::subGetClassID ( void * pClsid ) const

virtual

Reimplemented from OdDbSpline.

◆ subTransformBy()

virtual OdResult OdDbHelix::subTransformBy ( const OdGeMatrix3d & xfm )

virtual

Applies the specified 3D transformation matrix to this entity.

Parameters

xfm	[in] 3D transformation matrix.

Returns: Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbSpline.

◆ topRadius()

double OdDbHelix::topRadius ( ) const

◆ totalLength()

double OdDbHelix::totalLength ( ) const

◆ turnHeight()

double OdDbHelix::turnHeight ( ) const

◆ turns()

double OdDbHelix::turns ( ) const

◆ turnSlope()

double OdDbHelix::turnSlope ( ) const

◆ twist()

bool OdDbHelix::twist ( ) const

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

DbHelix.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ConstrainType

Constructor & Destructor Documentation

◆ OdDbHelix()

Member Function Documentation

◆ axisPoint()

◆ axisVector()

◆ baseRadius()

◆ constrain()

◆ createHelix()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ height()

◆ ODDB_DECLARE_MEMBERS()

◆ reverseCurve()

◆ setAxisPoint()

◆ setAxisVector()

◆ setBaseRadius()

◆ setConstrain()

◆ setHeight()

◆ setStartPoint()

◆ setTopRadius()

◆ setTurnHeight()

◆ setTurns()

◆ setTwist()

◆ startPoint()

◆ subExplode()

◆ subGetClassID()

◆ subTransformBy()

◆ topRadius()

◆ totalLength()

◆ turnHeight()

◆ turns()

◆ turnSlope()

◆ twist()