OdBmFamilyBase Class

Syntax

C++

class OdBmFamilyBase : public OdBmElement;

Description

This is the base class for family classes.

Class Hierarchy

File: BmFamilyBase.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. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead. (Inherited from OdBmElement)
assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdBmElement)
changeTypeId	Changes the type of the element. (Inherited from OdBmElement)
clone	Clones the object. (Inherited from OdBmObject)
database	Returns database associated with this element as a pointer to the OdBmDatabase object. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
getAbFlags4Bytes	Calls the getAbFlags4Bytes method of the related OdBmElementHeader. (Inherited from OdBmElement)
getAllowCutWithUnattachedVoids	Retrieves whether the family allows to cut with unattached voids.
getAppVersionAtInitialLoad	Retrieves the current application version at initial loading.
getAppVersionAtLoad	Retrieves the current application version at loading.
getAssemblyInstanceId	Returns the Id of the assembly to which the element belongs. (Inherited from OdBmElement)
getAssocLevelId	Returns the AssocLevelId of this element. (Inherited from OdBmElement)
getBBox	Calls the getBBox method of the related OdBmElementHeader. (Inherited from OdBmElement)
getBaseDesignOptionId	Returns the Id of Design Option which was read from a file. (Inherited from OdBmElement)
getBeamCutbackForColumn	Retrieves the current beam cutback for a column.
getBraceRepType	Retrieves the current brace representation type.
getCanHostRebar	Retrieves whether the family can host rebar.
getCellList	Returns the cell list of this element. (Inherited from OdBmElement)
getClassDef	Calls the getClassDef method of the related OdBmElementHeader. (Inherited from OdBmElement)
getConstrInfo	Fetches constraint info and writes to the passed argument. (Inherited from OdBmElement)
getContentProtected	Retrieves whether the family's content is protected.
getCouldAutojoin	Retrieves whether a data can be auto-join to the family.
getCreatedPhaseId	Returns the created phase id of this element. (Inherited from OdBmElement)
getCurveBased	Retrieves whether the family is curve based.
getCutback	Retrieves whether the family is a cutback.
getDBViewInfos	Retrieves the array of DB Views.
getDatabase	Returns the database of this element. (Inherited from OdBmElement)
getDatabase2	Retrieves a BimRv database object associated with the family.
getDeletableElements	Retrieves the identifiers of deletable elements for the family.
getDemolishedPhaseId	Returns the demolished phase id of this element. (Inherited from OdBmElement)
getDesignOptionId	Returns the Id of Design Option. (Inherited from OdBmElement)
getDoubleParams	Returns the DoubleParams of this element. (Inherited from OdBmElement)
getDrawableSubElementsIds	Retrieves the ids of sub-elements drawn by the element. For example BmBaseRailing will collect all HandRail and Supports ids of railing system. (Inherited from OdBmElement)
getDummy	Checks if this is a dummy element. (Inherited from OdBmElement)
getDumpSymName	Retrieves the dump symbolic name.
getDynamicObject	Returns a dynamic object, that represents data for elements of types that are not supported by the latest file format. (Inherited from OdBmElement)
getESEntities	Returns all ESEntities in the element. (Inherited from OdBmElement)
getESEntity	Returns the entity in the element by specified GUID. (Inherited from OdBmElement)
getElecKeepAnnotationOrientation	Retrieves whether the family maintains annotation orientation.
getElemRec	Returns the ElemRec of this element. (Inherited from OdBmElement)
getElementName	Returns the element name as OdString value. (Inherited from OdBmElement)
getElevationMarkBody	Retrieves whether the family uses elevation mark.
getEnableCuttingInViews	Retrieves whether the family enables cutting in views.
getExportId	Retrieves the global unique identifier (GUID) of an element for DWF and IFC export. (Inherited from OdBmElement)
getExtraFillingAttributes	Sets up element extra filling attributes if required. Returns true in this case and false otherwise (Inherited from OdBmElement)
getFamId	Returns the family id of this element. (Inherited from OdBmElement)
getFamilyCatalogKeysItem
getFamilyCategoryId	Retrieves the identifier of the current family category.
getFamilyDocGUID	Retrieves the family global unique identifier (GUID).
getFamilyDocument	Retrieves family's document.
getFamilyIds	Retrieves the set of the family identifiers.
getFamilyName	Returns the family name as OdString value. (Inherited from OdBmElement)
getFamilyNameKeyText	Retrieves the text of the family name key.
getFamilyParams	Retrieves the current parameters of the family.
getFamilySymbolDependentObjects
getFamilyTypes	Retrieves the family types.
getFilterElement(const OdBm::BuiltInParameter::Enum&)	This is the overview for the getFilterElement method overload.
getForceProperMirroring	Retrieves whether the family is forsed to proper mirroring.
getFromADPx	Retrieves whether the family is from ADPX or not.
getGeomExtents	Returns geometry extents of this element as an object of OdGeExtents3d class. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
getGeomTable	Updated geometry if required and returns the geometry table of this element. (Inherited from OdBmElement)
getGeometry()	This is the overview for the getGeometry method overload.
getGroupId	Retrieves the Id of the Group to which the element belongs. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
getHasBaseArrays	Retrieves whether the family has base arrays
getHasComplexCuts	Retrieves whether the family has complex cuts.
getHasInstances	Retrieves whether the family has instances
getHasLabeledDimensions	Retrieves whether the family has labeled dimensions.
getHasRoomCalculationPoint	Retrieves whether the family has room calculation point
getHasSimpleCuts	Retrieves whether the family has simple cuts.
getHasTypesFromCatalog	Retrieves whether the family has types form the catalog.
getHeader	Returns the header part of this element. (Inherited from OdBmElement)
getHeaderCategoryId	Calls the getHeaderCategoryId method of the related OdBmElementHeader. (Inherited from OdBmElement)
getHistory	Calls the getHistory method of the related OdBmElemRec. (Inherited from OdBmElement)
getHostFaceGeomRef	Retrieves the reference to the face geometry of the family's host.
getInPlace	Retrieves whether the family is an in-place family or is a loadable one.
getIntParams	Returns the IntParams of this element. (Inherited from OdBmElement)
getIs2d	Retrieves whether the family is a 2d-family.
getIsAboutToBecomeParametric	Retrieves whether the family is about to become a parametric family.
getIsAdHoc	Retrieves whether the family is an AdHoc.
getIsCrvDriven	Retrieves whether the family is a curve driven family.
getIsCurtainPanel	Retrieves whether the family is a curtain panel family.
getIsHostBased	Retrieves whether the family is host based
getIsModel	Retrieves whether the family is a model family.
getIsNew2010	Retrieves whether the family family has 2010 format.
getIsParametric	Retrieves whether the family has parametric relations between its components.
getIsRebarShape	Retrieves whether the family contains rebar shape type.
getIsSavable	Retrieves whether the family is a savable family.
getIsSelfOrienting	Retrieves whether the family is self-oriented.
getIsShared	Retrieves whether the family is shared
getIsSpiralShape	Retrieves whether the family is a spiral shape.
getIsVertical	Retrieves whether the family is vertical or horizontal.
getIsWorkPlaneBased	Retrieves whether the family is work plane based
getKeepTextReadable	Retrieves whether the family text should be kept readable.
getKeyExtParamId	Retrieves the identifier of the family filter parameter.
getLightSourceDefBits	Retrieves the current light source definition bits.
getListParams	Retrieves the list of parameters. (Inherited from OdBmObject)
getLocked	Checks if this element is locked. (Inherited from OdBmElement)
getLockedParameterIdsForDirectManipulation	Retrieves the array that contains identifiers of the locked parameters for direct manipulation.
getMaterialArea	Returns the area of the material with the specified id. (Inherited from OdBmElement)
getMaterialIds	Retrieves the ids of all materials of the element. (Inherited from OdBmElement)
getMaterialVolume	Returns the volume of the material with the specified id. (Inherited from OdBmElement)
getMiscId	Calls the getMiscId method of the related OdBmElementHeader. (Inherited from OdBmElement)
getMoribund	Checks if this element is moribund. (Inherited from OdBmElement)
getName	Retrieves the family name.
getNextAbsorbedIndex	Retrieves the next absorbed index for the family.
getObjectIdParams	Returns the ObjectIdParams of this element. (Inherited from OdBmElement)
getOldCurveElemsWithBadSketchAndSP	Retrieves the array that contains identifiers of the old curves with bad sketches.
getOmniClassCode	Retrieves the omniclass number.
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. (Inherited from OdBmElement)
getOwnerSymbolId	Retrieves the owner symbol identifier.
getOwningElementId	Calls the getOwningElementId method of the related OdBmElemRec. remarks Throws eNotHandled if this element is null. (Inherited from OdBmElement)
getPanelConfig	Retrieves the current panel configuration for the family.
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. (Inherited from OdBmElement)
getPartType	Retrieves the current part type of the family.
getPartitionId	Calls the getPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
getPath	Retrieves the current path to the family.
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdBmObject)
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdTfObject)
getPredefinedLimitIdx	Retrieves the current predefined limit for the family.
getProfileFamDefinition	Retrieves the current profile families definition.
getProfileFamUsage	Retrieves the current profile families.
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.
getProtectionAccessKey	Retrieves the current projection access key.
getProteinRenderType	Retrieves the current protein render type.
getRegenHistory	Calls the getRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
getRegeneratingGroupId	Retrieves the identifier of the regeneration group.
getRenderModelType	Retrieves the current rendering model type for the family.
getRotateTagTextWithComponent
getRotateTagWithComponent	Retrieves whether the family's tag is rotated with a component.
getRoundConnDimType	Retrieves the current round connector dimension type.
getSeekItemId	Retrieves the identifier of the seek item.
getShortDescriptiveName	Returns the descriptive element name as OdString value. (Inherited from OdBmElement)
getShouldStayParametric	Retrieves whether the family should stay a parametric family.
getStretchingDisallowed	Retrieves whether the family disallows stretching.
getStringParams	Returns the StringParams of this element. (Inherited from OdBmElement)
getStructConnectionApplyTo	Retrieves the connection on which the family should be connected to.
getStructHiddenViewDisplayType	Retrieves the current display type of a hidden view.
getStructUseCap	Retrieves whether the family is using cap.
getStructuralCodeName	Retrieves the current structural code name of the family.
getStructuralMaterialType	Retrieves the current physical material type of the family.
getSubentPathsAtGsMarker	(Inherited from OdBmElement)
getSymbolicRepType	Retrieves the current symbolic representation type of the family.
getTagCurveAttachmentProportion	Retrieves the current curve attachment point tag.
getTransientReactors	Retrieves all the transient reactors from the element. (Inherited from OdBmObject)
getTransientReactors	Retrieves all the transient reactors from the element. (Inherited from OdTfObject)
getTrivialParamIds	Retrieves the array of trivial parameter identifiers for the family.
getTypeID	Returns the element type id if available. (Inherited from OdBmElement)
getTypeName	Returns the element's type name as OdString value. (Inherited from OdBmElement)
getUniqueCell	Return a cell by the OdTfClass from CellList. (Inherited from OdBmElement)
getUniqueId	Returns the unique identifier for the element from the database. (Inherited from OdBmElement)
getUnplacedOwnerId	Returns the unplaced owner id of this element. (Inherited from OdBmElement)
getUsePreCutShape	Retrieves whether the family shows pre-cut in plan view
getVersionGuid	Returns the unique identifier for the element from the database. (Inherited from OdBmElement)
getViewRules	Calls the getViewRules method of the related OdBmElementHeader. (Inherited from OdBmElement)
getWorksetId	Returns the Id of the Workset which owns the element. (Inherited from OdBmElement)
gsNode	Retrieves graphical system cache associated with the object. (Inherited from OdBmObject)
hasDesignPropManager	Checks if the element has DesignPropertyManager. (Inherited from OdBmElement)
hasDrawableSubElements	Checks if element has a drawable sub-elements. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
id	Retrieves the object's identifier in the associated database. (Inherited from OdBmObject)
isClippable	Returns true if this element could be clipped (Inherited from OdBmElement)
isDBRO	Returns true if and only this object is a database -resident object. (Inherited from OdBmElement)
isEditMode	Retrieves whether the Edit mode is enabled for the database. (Inherited from OdBmElement)
isEditable	Retrieves whether the family supports editing.
isInAFamily	Returns true if and only if this element is a part of a family. (Inherited from OdBmElement)
isNewObject	Returns true if and only if this object has not been closed since it was created. (Inherited from OdBmElement)
isPersistent	Retrieves whether the object is persistent or not. (Inherited from OdBmObject)
isRegistred	Checks whether a specified identifier is registered in the family.
isSectionable	Returns true if this element could be sectioned (Inherited from OdBmElement)
isValidType	Checks if given type is valid for this element. (Inherited from OdBmElement)
isVisibleInView	Checks if this element is visible on the specified view. (Inherited from OdBmElement)
numRefs	Retrieves the current quantity of references to the object. (Inherited from OdBmObject)
objectId	Returns the OdBmObjectId of this element. (Inherited from OdBmElement)
owningElemId	Returns the ID of the element's owning element as an OdBmObjectId object. (Inherited from OdBmElement)
popParam(const OdBm::BuiltInParameter::Enum&, OdBmObjectId&)	This is the overview for the popParam method overload.
registerId	Registers a specified identifier in the family.
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. (Inherited from OdBmElement)
setAbFlags4Bytes	Calls the setAbFlags4Bytes method of the related OdBmElementHeader. (Inherited from OdBmElement)
setAppVersionAtInitialLoad	Sets a new application version at initial loading.
setAppVersionAtLoad	Sets a new application version at loading.
setAssocLevelId	Sets the AssocLevelId for this element. (Inherited from OdBmElement)
setBBox	Calls the setBBox method of the related OdBmElementHeader. (Inherited from OdBmElement)
setBaseDesignOptionId	Sets the Id of Base Design Option. (Inherited from OdBmElement)
setBeamCutbackForColumn	Sets a new beam cutback for a column.
setBraceRepType	Sets a new value of the brace representation type.
setCellList	Sets the cell list for this element. (Inherited from OdBmElement)
setClassDef	Calls the setClassDef method of the related OdBmElementHeader. (Inherited from OdBmElement)
setConstrInfo	Sets constraint info for this element. (Inherited from OdBmElement)
setCreatedPhaseId	Sets the created phase id for this element. (Inherited from OdBmElement)
setDBViewInfos	Sets a new array of DB Views for the family.
setDatabase	Sets the database for this element. (Inherited from OdBmElement)
setDatabase2	Associates a specified BimRv database with the family.
setDatabaseDefaults	Applies the default properties of the specified database to this entity. (Inherited from OdBmObject)
setDemolishedPhaseId	Sets the demolished phase id for this element. (Inherited from OdBmElement)
setDoubleParams	Sets the DoubleParams for this element. (Inherited from OdBmElement)
setDummy	Sets a value to the dummy flag of this element. (Inherited from OdBmElement)
setDumpSymName	Sets a new dump symbolic name.
setESEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from OdBmElement)
setElementName	Sets a new name of the element. (Inherited from OdBmElement)
setElevationMarkBody	Sets a new value of the elevation mark flag. This flag determines whether the family uses an elevation mark (if is equal to true) or not (if is equal to false).
setEnableCuttingInViews	Sets a new value of the cutting in views flag. This flag determines whether cutting views are enabled (if is equal to true) or not (if is equal to false) for the family.
setFamId	Sets the family id for this element. (Inherited from OdBmElement)
setFamilyCategoryId	Sets a new family category identifier.
setFamilyDocGUID	Sets a new family global unique identifier (GUID).
setFamilyIds	Sets a new set of family identifiers.
setFamilyParams	Sets new family parameters.
setFamilyTypes	Sets a new family type table.
setGeomSteps	Sets the geometry step list for this element. (Inherited from OdBmElement)
setGeomTable	Sets the geometry table for this element. (Inherited from OdBmElement)
setGsNode	Assigns the specified OdGsCache to this object. (Inherited from OdBmObject)
setHistory	Calls the setHistory method of the related OdBmElemRec. (Inherited from OdBmElement)
setInPlace	Sets new value of the in-place flag. In-place flag determines whether the family is an in-place family (if it is equal to true) or not (if it is equal to false).
setIntParams	Sets the IntParams for this element. (Inherited from OdBmElement)
setIsModel	Sets new value of the model flag. The model flag determines whether the family is a model family (if it is equal to true) or not (if it is equal to false).
setIsParametric	Sets a new value of the parametric relations flag. This flag determines whether the family has parametric relations between its components (if is equal to true) or not (if is equal to false).
setLightSourceDefBits	Sets new light source definition bits.
setLocked	Sets a value to the locked flag of this element. (Inherited from OdBmElement)
setMiscId	Calls the setMiscId method of the related OdBmElementHeader. (Inherited from OdBmElement)
setMoribund	Sets a value to the moribund flag of this element. (Inherited from OdBmElement)
setName	Sets a new family name.
setNextAbsorbedIndex	Sets the next absorbed index for the family.
setObjectIdParams	Sets the ObjectIdParams for this element. (Inherited from OdBmElement)
setOwnerDBViewId	Sets the owner database view id for this element. (Inherited from OdBmElement)
setOwnerSymbolId	Sets a new owner symbol Id.
setOwningElementId	Calls the setOwningElementId method of the related OdBmElemRec. (Inherited from OdBmElement)
setPanelConfig	Sets a new panel configuration value.
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. (Inherited from OdBmElement)
setPartType	Sets a new part type of the family.
setPartitionId	Calls the setPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
setPath	Sets a new family path.
setPredefinedLimitIdx	Sets a new predefined limit value for the family.
setProfileFamDefinition	Sets a new profile families definition.
setProfileFamUsage	Sets new profile families.
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.
setProteinRenderType	Sets a new protein render type value.
setRegenHistory	Calls the setRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
setRenderModelType	Sets a new rendering model type for the family.
setRoundConnDimType	Sets a new round connector dimension type.
setStringParams	Sets the StringParams for this element. (Inherited from OdBmElement)
setStructConnectionApplyTo	Sets the connection on which the family should be connected to.
setStructHiddenViewDisplayType	Sets a new display type of a hidden view.
setStructuralMaterialType	Sets a new physical material type value for the family.
setSymbolicRepType	Sets a new symbolic representation type for the family.
setTagCurveAttachmentProportion	Sets a new curve attachment point tag.
setUnplacedOwnerId	Sets the unplaced owner id for this element. (Inherited from OdBmElement)
setUsePreCutShape	Sets new value of the flag which controls whether the family shows pre-cut in plan view. If the flag value is equal to true, the family shows pre-cut in plan view; otherwise, if the flag is equal to false, the family does not.
setViewRules	Calls the setViewRules method of the related OdBmElementHeader. (Inherited from OdBmElement)
subHighlight	The method is used to highlight an element. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)
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. (Inherited from OdBmElement)

Nested Types

Show:Inherited

No members matching the current filter

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

Links

OdBmFamilyBase Methods

Relief for ODA Team in Ukraine