OdBmElement Class

Syntax

C++

class OdBmElement : public OdBmObject;

Description

This is a base class for BimRv elements.

Class Hierarchy

File: BmElement.h

Methods

Show:Inherited

No members matching the current filter

~OdBmObject

A destructor for the BimRv object. (Inherited from OdBmObject)

Methods

Show:Inherited

No members matching the current filter

addCell	Adds a cell to the element.
addParam(const OdBm::BuiltInParameter::Enum&, const OdBmObjectId&)	This is the overview for the addParam method overload.
addPersistentReactor	Adds a new persistent reactor object to the element's reactor list. (Inherited from OdBmObject)
addPersistentReactor	Adds a new persistent reactor object to the element's reactor list. (Inherited from OdTfObject)
addReactor	Adds a new transient reactor object to the element's reactor list. (Inherited from OdBmObject)
addReactor	Adds a new transient reactor object to the element's reactor list. (Inherited from OdTfObject)
addRef	Increments the counter of references to the object. (Inherited from OdBmObject)
assertNotifyEnabled	Throws an exception if this object is not open OdDb::kForNotify.
assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead.
assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications.
changeTypeId	Changes the type of the element.
clone	Clones the object. (Inherited from OdBmObject)
database	Returns database associated with this element as a pointer to the OdBmDatabase object.
database	Retrieves the related database object. (Inherited from OdBmObject)
drawableType	Retrieves the drawable type of the object. (Inherited from OdBmObject)
finishEditMode	Disable edit mode for element.
getAbFlags4Bytes	Calls the getAbFlags4Bytes method of the related OdBmElementHeader.
getAssemblyInstanceId	Returns the Id of the assembly to which the element belongs.
getAssocLevelId	Returns the AssocLevelId of this element.
getBBox	Calls the getBBox method of the related OdBmElementHeader.
getBaseDesignOptionId	Returns the Id of Design Option which was read from a file.
getCellList	Returns the cell list of this element.
getClassDef	Calls the getClassDef method of the related OdBmElementHeader.
getConstrInfo	Fetches constraint info and writes to the passed argument.
getCreatedPhaseId	Returns the created phase id of this element.
getDatabase	Returns the database of this element.
getDemolishedPhaseId	Returns the demolished phase id of this element.
getDesignOptionId	Returns the Id of Design Option.
getDoubleParams	Returns the DoubleParams of this element.
getDrawableSubElementsIds	Retrieves the ids of sub-elements drawn by the element. For example BmBaseRailing will collect all HandRail and Supports ids of railing system.
getDummy	Checks if this is a dummy element.
getDynamicObject	Returns a dynamic object, that represents data for elements of types that are not supported by the latest file format.
getESEntities	Returns all ESEntities in the element.
getESEntity	Returns the entity in the element by specified GUID.
getElemRec	Returns the ElemRec of this element.
getElementName	Returns the element name as OdString value.
getExportId	Retrieves the global unique identifier (GUID) of an element for DWF and IFC export.
getExtraFillingAttributes	Sets up element extra filling attributes if required. Returns true in this case and false otherwise
getFamId	Returns the family id of this element.
getFamilyName	Returns the family name as OdString value.
getFilterElement(const OdBm::BuiltInParameter::Enum&)	This is the overview for the getFilterElement method overload.
getGeomExtents	Returns geometry extents of this element as an object of OdGeExtents3d class.
getGeomExtents	Returns a WCS bounding box that represents the extents of this object. (Inherited from OdBmObject)
getGeomSteps	Updates geometry if it's required and returns geometry step list.
getGeomTable	Updated geometry if required and returns the geometry table of this element.
getGeometry()	This is the overview for the getGeometry method overload.
getGroupId	Retrieves the Id of the Group to which the element belongs.
getGsMarkersAtSubentPath	Returns all graphic system marker by subentity paths for complex entities, that has the ability to associate an integer identifier (GS marker) with each graphic primitive or with groups of primitives during draw themself.
getHeader	Returns the header part of this element.
getHeaderCategoryId	Calls the getHeaderCategoryId method of the related OdBmElementHeader.
getHistory	Calls the getHistory method of the related OdBmElemRec.
getIntParams	Returns the IntParams of this element.
getListParams	Retrieves the list of parameters. (Inherited from OdBmObject)
getLocked	Checks if this element is locked.
getMaterialArea	Returns the area of the material with the specified id.
getMaterialIds	Retrieves the ids of all materials of the element.
getMaterialVolume	Returns the volume of the material with the specified id.
getMiscId	Calls the getMiscId method of the related OdBmElementHeader.
getMoribund	Checks if this element is moribund.
getObjectIdParams	Returns the ObjectIdParams of this element.
getOwner	Retrieves the object's owner object. (Inherited from OdBmObject)
getOwner	Retrieves the object's owner object. (Inherited from OdTfObject)
getOwnerDBViewId	Returns the owner database view id of this element.
getOwningElementId	Calls the getOwningElementId method of the related OdBmElemRec. remarks Throws eNotHandled if this element is null.
getParam(const OdBm::BuiltInParameter::Enum&, OdBmObjectId&)	This is the overview for the getParam method overload.
getParamValueAsString(const OdBm::BuiltInParameter::Enum, OdString&)	This is the overview for the getParamValueAsString method overload.
getParents	Calls the getParents method of the related OdBmElementHeader.
getPartitionId	Calls the getPartitionId method of the related OdBmElemRec.
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdBmObject)
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdTfObject)
getProperties	Retrieves the array of object's properties. (Inherited from OdBmObject)
getProperty(const OdString&, OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the getProperty method overload.
getProperty(const OdString&, OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the getProperty method overload.
getProperty(const OdString&, OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the getProperty method overload.
getRegenHistory	Calls the getRegenHistory method of the related OdBmElementHeader.
getShortDescriptiveName	Returns the descriptive element name as OdString value.
getStringParams	Returns the StringParams of this element.
getSubentPathsAtGsMarker
getTransientReactors	Retrieves all the transient reactors from the element. (Inherited from OdBmObject)
getTransientReactors	Retrieves all the transient reactors from the element. (Inherited from OdTfObject)
getTypeID	Returns the element type id if available.
getTypeName	Returns the element's type name as OdString value.
getUniqueCell	Return a cell by the OdTfClass from CellList.
getUniqueId	Returns the unique identifier for the element from the database.
getUnplacedOwnerId	Returns the unplaced owner id of this element.
getVersionGuid	Returns the unique identifier for the element from the database.
getViewRules	Calls the getViewRules method of the related OdBmElementHeader.
getWorksetId	Returns the Id of the Workset which owns the element.
gsNode	Retrieves graphical system cache associated with the object. (Inherited from OdBmObject)
hasDesignPropManager	Checks if the element has DesignPropertyManager.
hasDrawableSubElements	Checks if element has a drawable sub-elements.
hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element. (Inherited from OdBmObject)
hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element. (Inherited from OdTfObject)
highlight	Highlights or unhighlights the specified path.
id	Retrieves the object's identifier in the associated database. (Inherited from OdBmObject)
isClippable	Returns true if this element could be clipped
isDBRO	Returns true if and only this object is a database -resident object.
isEditMode	Retrieves whether the Edit mode is enabled for the database.
isInAFamily	Returns true if and only if this element is a part of a family.
isNewObject	Returns true if and only if this object has not been closed since it was created.
isPersistent	Retrieves whether the object is persistent or not. (Inherited from OdBmObject)
isSectionable	Returns true if this element could be sectioned
isValidType	Checks if given type is valid for this element.
isVisibleInView	Checks if this element is visible on the specified view.
numRefs	Retrieves the current quantity of references to the object. (Inherited from OdBmObject)
objectId	Returns the OdBmObjectId of this element.
owningElemId	Returns the ID of the element's owning element as an OdBmObjectId object.
popParam(const OdBm::BuiltInParameter::Enum&, OdBmObjectId&)	This is the overview for the popParam method overload.
release	Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed. (Inherited from OdBmObject)
removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list. (Inherited from OdBmObject)
removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list. (Inherited from OdTfObject)
removeReactor	Removes a specified transient reactor object from the element's reactor list. (Inherited from OdBmObject)
removeReactor	Removes a specified transient reactor object from the element's reactor list. (Inherited from OdTfObject)
runEditMode	Retrieves edit manager for element and set element to edit mode.
setAbFlags4Bytes	Calls the setAbFlags4Bytes method of the related OdBmElementHeader.
setAssocLevelId	Sets the AssocLevelId for this element.
setBBox	Calls the setBBox method of the related OdBmElementHeader.
setBaseDesignOptionId	Sets the Id of Base Design Option.
setCellList	Sets the cell list for this element.
setClassDef	Calls the setClassDef method of the related OdBmElementHeader.
setConstrInfo	Sets constraint info for this element.
setCreatedPhaseId	Sets the created phase id for this element.
setDatabase	Sets the database for this element.
setDatabaseDefaults	Applies the default properties of the specified database to this entity. (Inherited from OdBmObject)
setDemolishedPhaseId	Sets the demolished phase id for this element.
setDoubleParams	Sets the DoubleParams for this element.
setDummy	Sets a value to the dummy flag of this element.
setESEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
setElementName	Sets a new name of the element.
setFamId	Sets the family id for this element.
setGeomSteps	Sets the geometry step list for this element.
setGeomTable	Sets the geometry table for this element.
setGsNode	Assigns the specified OdGsCache to this object. (Inherited from OdBmObject)
setHistory	Calls the setHistory method of the related OdBmElemRec.
setIntParams	Sets the IntParams for this element.
setLocked	Sets a value to the locked flag of this element.
setMiscId	Calls the setMiscId method of the related OdBmElementHeader.
setMoribund	Sets a value to the moribund flag of this element.
setObjectIdParams	Sets the ObjectIdParams for this element.
setOwnerDBViewId	Sets the owner database view id for this element.
setOwningElementId	Calls the setOwningElementId method of the related OdBmElemRec.
setParam(const OdBm::BuiltInParameter::Enum&, const OdBmObjectId&)	This is the overview for the setParam method overload.
setParents	Calls the setParents method of the related OdBmElementHeader.
setPartitionId	Calls the setPartitionId method of the related OdBmElemRec.
setProperty(const OdString&, const OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the setProperty method overload.
setProperty(const OdString&, const OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the setProperty method overload.
setProperty(const OdString&, const OdTfVariant&, const ItemIndexType, const OdTfClass*)	This is the overview for the setProperty method overload.
setRegenHistory	Calls the setRegenHistory method of the related OdBmElementHeader.
setStringParams	Sets the StringParams for this element.
setUnplacedOwnerId	Sets the unplaced owner id for this element.
setViewRules	Calls the setViewRules method of the related OdBmElementHeader.
subHighlight	The method is used to highlight an element.
subRegenSupportFlags	Retrieves the current regeneration support flags set for the object. (Inherited from OdBmObject)
subSetAttributes	Sets the vectorization attributes of the object, and returns its attribute flags. (Inherited from OdBmObject)
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set. (Inherited from OdBmObject)
subViewportDraw	Implements viewport-dependent rendering. (Inherited from OdBmObject)
subWorldDraw	Implements the mechanism for rendering the object. (Inherited from OdBmObject)
transformBy	Transform element with given matrix.

Nested Types

Show:Inherited

No members matching the current filter

ItemIndexType	(Inherited from OdBmObject)
PropertyIndexType	(Inherited from OdBmObject)

Links

OdBmElement Methods

Relief for ODA Team in Ukraine