#include <BrEntity.h>

Inheritance diagram for OdBrEntity:

Public Member Functions
bool	isNull () const

bool	isEqualTo (const OdBrEntity *pOtherEntity) const

bool	getBrep (OdBrBrep &brep) const

bool	checkEntity () const

OdBrErrorStatus	getSubentPath (OdDbBaseFullSubentPath &subPath) const

virtual	~OdBrEntity ()

OdBrErrorStatus	setSubentPath (OdBrBrep &brep, OdDbBaseFullSubentPath &subpath)

OdBrErrorStatus	getPointContainment (const OdGePoint3d &point, OdGe::PointContainment &containment, OdBrEntity *&brEntContainer) const

OdBrErrorStatus	getLineContainment (const OdGeLinearEnt3d &line, const OdUInt32 &iNumHitsWanted, OdUInt32 &iNumHitsFound, OdBrHit *&brHit) const

OdBrErrorStatus	getBoundBlock (OdGeBoundBlock3d &block) const

OdBrErrorStatus	setValidationLevel (const BrValidationLevel &level)

OdBrErrorStatus	getValidationLevel (BrValidationLevel &level) const

OdUInt32	getFlags () const

OdBrErrorStatus	getGsMarker (OdGsMarker &marker) const

OdBrErrorStatus	getMassProps (OdBrMassProps &massProps, const double &dDensity=dUnspecified, const double &dTolRequired=dUnspecified, double &dTolAchieved=dUnspecified) const

OdBrErrorStatus	getVolume (double &dVolume, const double &dTolRequired=dUnspecified, double &dTolAchieved=dUnspecified) const

OdBrErrorStatus	getSurfaceArea (double &dArea, const double &dTolRequired=dUnspecified, double &dTolAchieved=dUnspecified) const

OdBrErrorStatus	getPerimeterLength (double &dLength, const double &dTolRequired=dUnspecified, double &dTolAchieved=dUnspecified) const

OdUInt64	getUniqueId () const

Static Public Attributes
static ODBR_TOOLKIT_EXPORT_STATIC double	dUnspecified

Protected Member Functions
	OdBrEntity ()

Protected Attributes
void *	m_pImp

OdSharedPtr< OdDbStubPtrArray >	m_pFSubentPath

bool	m_bIsValidate

Friends
class	OdBrEntityInternals

Detailed Description

This class is the interface base class for BREP topology objects.

Corresponding C++ library: TD_Br

Definition at line 54 of file BrEntity.h.

Constructor & Destructor Documentation

◆ ~OdBrEntity()

virtual OdBrEntity::~OdBrEntity ( )

virtual

Destructor for objects of the OdBrEntity class.

◆ OdBrEntity()

OdBrEntity::OdBrEntity ( )

protected

Member Function Documentation

◆ checkEntity()

bool OdBrEntity::checkEntity ( ) const

Validates the element.

Returns: True if successful; false otherwise.

◆ getBoundBlock()

OdBrErrorStatus OdBrEntity::getBoundBlock ( OdGeBoundBlock3d & block ) const

Calculates the entity geometric bounds.

Parameters

block [out] Model space bounding box as OdGeBoundBlock3d.

Returns: odbrNotImplementedYet — if the method is not implemented for the current modeler. odbrUninitialisedObject — if the object is uninitialized. odbrInvalidInput — if the calculation was unsuccessful. odbrOK — if the calculation was successful.

◆ getBrep()

bool OdBrEntity::getBrep ( OdBrBrep & brep ) const

Returns the owner of this entity object.

Parameters

brep	[out] Owner of this entity object.

Returns: True if successful; false otherwise.

◆ getFlags()

OdUInt32 OdBrEntity::getFlags ( ) const

Returns the flags of the object.

Returns: Flags of the object.

See also: BrEntityFlags enumeration.

◆ getGsMarker()

OdBrErrorStatus OdBrEntity::getGsMarker ( OdGsMarker & marker ) const

Gets the Gs marker.

Parameters

marker [out] Gs marker value.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

◆ getLineContainment()

OdBrErrorStatus OdBrEntity::getLineContainment	(	const OdGeLinearEnt3d &	line,
		const OdUInt32 &	iNumHitsWanted,
		OdUInt32 &	iNumHitsFound,
		OdBrHit *&	brHit
	)		const

Gets the number of line containment hits and the array of contexted hit objects.

Parameters

line	[in] Line to get containment of.
iNumHitsWanted	[in] Expected number of containment hits.
iNumHitsFound	[out] Actual number of containment hits found.
brHit	[out] Array of contexted hit objects.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

Remarks: Currently not implemented. Returns odbrNotImplementedYet.

◆ getMassProps()

OdBrErrorStatus OdBrEntity::getMassProps	(	OdBrMassProps &	massProps,
		const double &	dDensity = `dUnspecified`,
		const double &	dTolRequired = `dUnspecified`,
		double &	dTolAchieved = `dUnspecified`
	)		const

Provides the mass properties for the entity. The mass properties are returned as an instance of OdBrMassProps structure. The density is used for the mass properties scaling and is the analogue of the physical value of the density of materials. The mass properties are applicable for those entities, that represent topology objects having the volume property.

Parameters

massProps	[out] Mass properties of the entity.
dDensity	[in] Density for calculating mass properties of the entity.
dTolRequired	[in] Tolerance required for the result of the calculation.
dTolAchieved	[out] Tolerance achieved in the calculation.

Returns: Value of the OdBrErrorStatus type.

Remarks: If density is not specified (dUnspecified), the default value is 1. If the mass properties are not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the mass properties argument remains unchanged.

◆ getPerimeterLength()

OdBrErrorStatus OdBrEntity::getPerimeterLength	(	double &	dLength,
		const double &	dTolRequired = `dUnspecified`,
		double &	dTolAchieved = `dUnspecified`
	)		const

Provides the perimeter length of the entity as a double value. The perimeter length property is applicable for most entities, that represent plane figures and some 3D figures.

Parameters

dLength	[out] Perimeter length of the entity.
dTolRequired	[in] Tolerance required for the result of the calculation.
dTolAchieved	[out] Tolerance achieved in the calculation.

Returns: Value of the OdBrErrorStatus type.

Remarks: If the perimeter length property is not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the perimeter length argument remains unchanged.

◆ getPointContainment()

OdBrErrorStatus OdBrEntity::getPointContainment	(	const OdGePoint3d &	point,
		OdGe::PointContainment &	containment,
		OdBrEntity *&	brEntContainer
	)		const

Gets the point containment and the corresponding container entity.

Parameters

point [in] Point to get containment of.

containment

[out] Containment type. Can be one of the following:

Description kInside Point is inside the boundary kOutside Point is outside the boundary kOnBoundary Point on the boundary

Parameters

brEntContainer [out] Container entity. Can be one of the following types:
OdBrBrep OdBrFace OdBrEdge OdBrVertex

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

Remarks: Currently not implemented. Returns odbrNotImplementedYet.

◆ getSubentPath()

OdBrErrorStatus OdBrEntity::getSubentPath ( OdDbBaseFullSubentPath & subPath ) const

Returns the FullSubentPath of this entity object.

Parameters

subPath [out] Full subentity path of this entity object.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

See also: OdDbBody::setSubentPath().

◆ getSurfaceArea()

OdBrErrorStatus OdBrEntity::getSurfaceArea	(	double &	dArea,
		const double &	dTolRequired = `dUnspecified`,
		double &	dTolAchieved = `dUnspecified`
	)		const

Provides the surface area of the entity as a double value. The surface area property is applicable for most entities, that represent volumetric figures.

Parameters

dArea	[out] Surface area of the entity.
dTolRequired	[in] Tolerance required for the result of the calculation.
dTolAchieved	[out] Tolerance achieved in the calculation.

Returns: Value of the OdBrErrorStatus type.

Remarks: If the surface area property is not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the surface area argument remains unchanged.

◆ getUniqueId()

OdUInt64 OdBrEntity::getUniqueId ( ) const

Returns the unique ID of the object.

Returns: Unique ID of the object.

Remarks: The ID is valid as long as the object exists at runtime. I.e., the ID shouldn't be saved in the file or used after operations that modify topology. Can be used as a key in an associative container.

◆ getValidationLevel()

OdBrErrorStatus OdBrEntity::getValidationLevel ( BrValidationLevel & level ) const

Gets the validation level.

Parameters

level [out] Validation level value. Can be one of the following:
odbrFullValidation if the object is validated. odbrNoValidation if the object is not validated.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

◆ getVolume()

OdBrErrorStatus OdBrEntity::getVolume	(	double &	dVolume,
		const double &	dTolRequired = `dUnspecified`,
		double &	dTolAchieved = `dUnspecified`
	)		const

Provides the volume of the entity as a double value. The volume property is applicable for most entities, that represent volumetric figures.

Parameters

dVolume	[out] Volume of the entity.
dTolRequired	[in] Tolerance required for the result of the calculation.
dTolAchieved	[out] Tolerance achieved in the calculation.

Returns: Value of the OdBrErrorStatus type.

Remarks: If the volume property is not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the volume argument remains unchanged.

◆ isEqualTo()

bool OdBrEntity::isEqualTo ( const OdBrEntity * pOtherEntity ) const

Returns true if and only if the specified entity object is equivalent to this entity object.

Parameters

pOtherEntity [in] Pointer to any OdBrEntity object.

Returns: True if the specified entity object is equivalent to this entity object; false otherwise.

Remarks: Two OdBrEntity objects are equivalent if and only if they are non-NULL, and have the same subentity path.

◆ isNull()

bool OdBrEntity::isNull ( ) const

Returns true if and only if there is no ACIS model associated with this entity object.

Returns: True if there is no ACIS model associated with this entity object; false otherwise.

◆ setSubentPath()

OdBrErrorStatus OdBrEntity::setSubentPath	(	OdBrBrep &	brep,
		OdDbBaseFullSubentPath &	subpath
	)

This method is for internal use only. Use OdDbBody::setSubentPath() instead.

Parameters

brep	[in] Owner.
subpath	[in] Full subentity path.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

◆ setValidationLevel()

OdBrErrorStatus OdBrEntity::setValidationLevel ( const BrValidationLevel & level )

Sets the validation level.

Parameters

level [in] Validation level value. Can be one of the following:
odbrFullValidation to set the object as validated. odbrNoValidation to set the object as not validated.

Returns: odbrOK if the operation is successful or the appropriate error code otherwise.

Friends And Related Function Documentation

◆ OdBrEntityInternals

friend class OdBrEntityInternals

friend

Definition at line 393 of file BrEntity.h.

Member Data Documentation

◆ dUnspecified

ODBR_TOOLKIT_EXPORT_STATIC double OdBrEntity::dUnspecified

static

Definition at line 372 of file BrEntity.h.

◆ m_bIsValidate

bool OdBrEntity::m_bIsValidate

protected

Definition at line 377 of file BrEntity.h.

◆ m_pFSubentPath

OdSharedPtr<OdDbStubPtrArray> OdBrEntity::m_pFSubentPath

protected

Definition at line 376 of file BrEntity.h.

◆ m_pImp

void* OdBrEntity::m_pImp

protected

Definition at line 375 of file BrEntity.h.

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

BrEntity.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~OdBrEntity()

◆ OdBrEntity()

Member Function Documentation

◆ checkEntity()

◆ getBoundBlock()

◆ getBrep()

◆ getFlags()

◆ getGsMarker()

◆ getLineContainment()

◆ getMassProps()

◆ getPerimeterLength()

◆ getPointContainment()

◆ getSubentPath()

◆ getSurfaceArea()

◆ getUniqueId()

◆ getValidationLevel()

◆ getVolume()

◆ isEqualTo()

◆ isNull()

◆ setSubentPath()

◆ setValidationLevel()

Friends And Related Function Documentation

◆ OdBrEntityInternals

Member Data Documentation

◆ dUnspecified

◆ m_bIsValidate

◆ m_pFSubentPath

◆ m_pImp