OdBmFamilySymbol Class

Syntax

C++

class OdBmFamilySymbol : public OdBmInsertableObj;

Description

This class represents a family symbol.

Class Hierarchy

File: BmFamilySymbol.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

activate	Activates the FamilySymbol. If the FamilySymbol is already active, then activation does not take place.
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)
getActive	Checks whether this FamilySymbol is active.
getArrConnectorData
getArrFamSymRegenData
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)
getCantBeStretched	Checks whether this FamilySymbol can be stretched.
getCellList	Returns the cell list of this element. (Inherited from OdBmElement)
getClassDef	Calls the getClassDef method of the related OdBmElementHeader. (Inherited from OdBmElement)
getClosurePlanes	Gets closure planes.
getComplexCutGeoms
getComplexCutRefIds	Gets the complex cut ref identrifiers.
getConfirmedStretchable	Checks whether this FamilySymbol's stretchability is confirmed.
getConstrInfo	Fetches constraint info and writes to the passed argument. (Inherited from OdBmElement)
getControlIconTags	Gets control icon tags.
getControlIcons	Gets control icons.
getCreatedPhaseId	Returns the created phase id of this element. (Inherited from OdBmElement)
getCutDirs	(Inherited from OdBmInsertableObj)
getCutIndices	(Inherited from OdBmInsertableObj)
getCutLoops	(Inherited from OdBmInsertableObj)
getCutPlaneHeightsItem
getDatabase	Returns the database of this element. (Inherited from OdBmElement)
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)
getDummyHostCutFaceTags
getDummyHostGeoms
getDummyHostInsertionFaceTags
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)
getElemRec	Returns the ElemRec of this element. (Inherited from OdBmElement)
getElementName	Returns the element name as OdString value. (Inherited from OdBmElement)
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)
getFaceBasedHostNormal
getFamId	Returns the family id of this element. (Inherited from OdBmElement)
getFamilyId	Gets the family identifier of this family symbol.
getFamilyName	Returns the family name as OdString value. (Inherited from OdBmElement)
getFilterElement(const OdBm::BuiltInParameter::Enum&)	This is the overview for the getFilterElement method overload.
getFlippedGeomRefHandlesSet
getGTagDirFlagsPairs	Gets GTag direction flag pairs.
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)
getGeomTag2MaterialId
getGeomTagOfDummyCurveRef	Gets the geometry tag of dummy curve ref.
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)
getHandleMgr	Gets a handle manager.
getHasNothingVisible	Checks whether this FamilySymbol has nothing visible.
getHasParamDefValue
getHasRotCenter	Checks whether this FamilySymbol has a rotation center.
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)
getHostLayersFlippedY	Checks whether this FamilySymbol host layer's Y-axis is flipped.
getIdxOfFirstCoreLayerRefFace	Gets the index of the first core layer of the ref face.
getImposterLightTrfs
getIntParams	Returns the IntParams of this element. (Inherited from OdBmElement)
getLabelParamTagInfo	Gets the label parameter tag information.
getLightSrcGReps
getLightSrcParamIds
getLightSrcValues
getListParams	Retrieves the list of parameters. (Inherited from OdBmObject)
getLocked	Checks if this element is locked. (Inherited from OdBmElement)
getMasterId	Gets the identifier of the master element.
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)
getMayBeStretchable	Checks whether this FamilySymbol may be stretchable.
getMirrored	Checks whether this FamilySymbol is mirrored.
getMiscId	Calls the getMiscId method of the related OdBmElementHeader. (Inherited from OdBmElement)
getMoribund	Checks if this element is moribund. (Inherited from OdBmElement)
getMoveRestrictions	Gets move restrictions.
getName	Returns the name of the Symbol. (Inherited from OdBmSymbol)
getNonBRepGeomPtrs	Gets non-brep geometry pointers.
getNotRotatedNodes
getOArrMembHistTable	Gets a member history table.
getOFamMoveRestrictions
getObjectIdParams	Returns the ObjectIdParams of this element. (Inherited from OdBmElement)
getOrigin	Gets an origin point.
getOutline	Gets an outline.
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)
getOwnerInstanceId	Gets the identifier of the owner instance.
getOwningElementId	Calls the getOwningElementId method of the related OdBmElemRec. remarks Throws eNotHandled if this element is null. (Inherited from OdBmElement)
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.
getParams	Gets the family parameters.
getParents	Calls the getParents method of the related OdBmElementHeader. (Inherited from OdBmElement)
getPartitionId	Calls the getPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
getPartitionSurrogateId	Gets the identifier of the partition surrogate.
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdBmObject)
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdTfObject)
getPretaggingGNodes
getPretaggingTranslations
getPreview	Checks whether the preview is available.
getPreviewElemId	(Inherited from OdBmSymbol)
getProfileLoops
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.
getRefFaces	Gets ref faces.
getRefs	Gets ref data.
getRegenHistory	Calls the getRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
getRenderStyleId	(Inherited from OdBmSymbol)
getRotCenter	Gets the rotation center point.
getSetOfInPlaceTotalParentIds
getShortDescriptiveName	Returns the descriptive element name as OdString value. (Inherited from OdBmElement)
getSlaveTrackerId
getStretchCount	Gets the stretch count.
getStretchPrototypeId	Gets the identifier of the stretch prototype.
getStringParams	Returns the StringParams of this element. (Inherited from OdBmElement)
getStrongRefs
getSubInstData
getSubentPathsAtGsMarker	(Inherited from OdBmElement)
getSymbolInfo	(Inherited from OdBmSymbol)
getTagNoteData	Gets tag note data.
getTextNoteData	Gets text note data.
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. (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)
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)
getVisibilityIsOld	Checks whether the visibility is old.
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)
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)
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)
numProfileLoops	It returns number of ProfileLoops
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.
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)
setActive	Changes the state of the Active flag to a new value.
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)
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)
setCutDirs	(Inherited from OdBmInsertableObj)
setCutIndices	(Inherited from OdBmInsertableObj)
setCutLoops	(Inherited from OdBmInsertableObj)
setCutPlaneHeightsItem
setDatabase	Sets the database for this element. (Inherited from OdBmElement)
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)
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)
setFamId	Sets the family id for this element. (Inherited from OdBmElement)
setFamilyId	Sets the family identifier for this family symbol.
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)
setHasParamDefValue
setHistory	Calls the setHistory method of the related OdBmElemRec. (Inherited from OdBmElement)
setIntParams	Sets the IntParams for this element. (Inherited from OdBmElement)
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)
setMoveRestrictions
setName	Set the Name for the Symbol. (Inherited from OdBmSymbol)
setOFamMoveRestrictions
setObjectIdParams	Sets the ObjectIdParams for this element. (Inherited from OdBmElement)
setOrigin	Sets the origin point.
setOutline	Sets an outline.
setOwnerDBViewId	Sets the owner database view id for this element. (Inherited from OdBmElement)
setOwnerInstanceId	Sets the owner instance identifier.
setOwningElementId	Calls the setOwningElementId method of the related OdBmElemRec. (Inherited from OdBmElement)
setParam(const OdBm::BuiltInParameter::Enum&, const OdBmObjectId&)	This is the overview for the setParam method overload.
setParams	Sets family parameters.
setParents	Calls the setParents method of the related OdBmElementHeader. (Inherited from OdBmElement)
setPartitionId	Calls the setPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
setPartitionSurrogateId	Sets the identifier for the partition surrogate.
setPreviewElemId	(Inherited from OdBmSymbol)
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.
setRefFaces	Sets ref faces.
setRegenHistory	Calls the setRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
setRenderStyleId	(Inherited from OdBmSymbol)
setRotCenter	Sets the rotation center point.
setStringParams	Sets the StringParams for this element. (Inherited from OdBmElement)
setSymbolInfo	(Inherited from OdBmSymbol)
setUnplacedOwnerId	Sets the unplaced owner id for this element. (Inherited from OdBmElement)
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

OdBmFamilySymbol Methods

Relief for ODA Team in Ukraine