OdDbRevolveOptions Class Reference

#include <DbRevolveOptions.h>

Public Member Functions
	OdDbRevolveOptions ()
	OdDbRevolveOptions (const OdDbRevolveOptions &src)
	~OdDbRevolveOptions ()
OdDbRevolveOptions &	operator= (const OdDbRevolveOptions &src)
double	draftAngle () const
void	setDraftAngle (double ang)
double	twistAngle () const
void	setTwistAngle (double ang)
bool	closeToAxis () const
void	setCloseToAxis (bool val)
OdResult	checkRevolveCurve (OdDbEntity *pRevEnt, const OdGePoint3d &axisPnt, const OdGeVector3d &axisDir, bool &closed, bool &endPointsOnAxis, bool &planar, bool displayErrorMessages=false)

Friends
class	OdDbRevolveOptionsImpl

Detailed Description

Class for setting options used for creating revolving surfaces and revolving solids (by calling OdDbRevolvedSurface::createRevolvedSurface() or OdDb3dSolid::createRevolvedSolid() methods). Revolve options are used to control the shape of the resulting surface or solid object.

<group OdDb_Classes>

Definition at line 40 of file DbRevolveOptions.h.

Constructor & Destructor Documentation

OdDbRevolveOptions() [1/2]

OdDbRevolveOptions::OdDbRevolveOptions

(

)

Creates an instance of revolving surface options.

OdDbRevolveOptions() [2/2]

OdDbRevolveOptions::OdDbRevolveOptions

(

const OdDbRevolveOptions &

src

)

Creates a copy of another instance of revolving surface options (copy constructor).

Parameters

src	[in] An instance of revolving surface options to be copied.

~OdDbRevolveOptions()

OdDbRevolveOptions::~OdDbRevolveOptions

(

)

Destroys the instance of revolving surface options.

Member Function Documentation

checkRevolveCurve()

OdResult OdDbRevolveOptions::checkRevolveCurve	(	OdDbEntity *	pRevEnt,
		const OdGePoint3d &	axisPnt,
		const OdGeVector3d &	axisDir,
		bool &	closed,
		bool &	endPointsOnAxis,
		bool &	planar,
		bool	displayErrorMessages = false
	)

Checks whether a specified entity is valid for the revolve operation.

Parameters

pRevEnt	[in] A pointer to the entity (curve or region) to be revolved.
axisPnt	[in] A point on the axis of revolution.
axisDir	[in] A vector determining the direction of the revolution axis.
closed	[out] A passed-in parameter for returning the indicator determining whether the revolved entity is closed.
endPointsOnAxis	[out] A passed-in parameter for returning the indicator determining whether the revolved entity is open and whether its endpoints lie on the axis of revolution.
planar	[out] A passed-in parameter for returning the indicator determining whether the revolved entity is planar.
displayErrorMessages	[in] Indicates whether error messages are displayed. Default value is false.

Returns

Returns eOk if a specified entity is valid for revolving, or eInvalidInput otherwise.

Remarks

The method is called by OdDbRevolvedSurface:: createRevolvedSurface() and OdDb3dSolid::createRevolvedSolid() methods, so it is not necessary for a client application to call it.

closeToAxis()

bool OdDbRevolveOptions::closeToAxis

(

)

const

Returns the value of the close to axis option.

If the close to axis option is equal to true, then the ends of the profile will be extended to the axis of revolution before revolving. The default value of the option is false.

draftAngle()

double OdDbRevolveOptions::draftAngle

(

)

const

Returns the draft angle in radians.

Draft angle is an angle of a profile's taper relative to the axis while the profile is revolving around the axis. The default value is equal to 0.0.

operator=()

OdDbRevolveOptions& OdDbRevolveOptions::operator=

(

const OdDbRevolveOptions &

src

)

Assigning operator for revolving surface options.

Parameters

src	[in] An instance of revolving surface options to be assigned to this instance.

setCloseToAxis()

void OdDbRevolveOptions::setCloseToAxis

(

bool

val

)

Sets the value of the close to axis option.

If the close to axis option is equal to true, then the ends of the profile will be extended to the axis of revolution before revolving. The default value of the option is false.

Parameters

val	[in] A new value of the close to axis option.

setDraftAngle()

void OdDbRevolveOptions::setDraftAngle

(

double

ang

)

Sets the draft angle.

Draft angle is an angle of a profile's taper relative to the axis while the profile is revolving around the axis. The default value is equal to 0.0.

Parameters

ang	[in] A new draft angle (radians).

setTwistAngle()

void OdDbRevolveOptions::setTwistAngle

(

double

ang

)

Sets the twist angle.

Twist angle is the angle of a profile's twisting while the profile is revolving around the axis in radians. The default value is equal to 0.0.

Parameters

ang	[in] A new twist angle (radians).

twistAngle()

double OdDbRevolveOptions::twistAngle

(

)

const

Returns the twist angle in radians.

Twist angle is the angle of a profile's twisting while the profile is revolving around the axis in radians. The default value is equal to 0.0.

Friends And Related Function Documentation

OdDbRevolveOptionsImpl

friend class OdDbRevolveOptionsImpl

friend

Definition at line 148 of file DbRevolveOptions.h.

---

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

• DbRevolveOptions.h