OdBmFamilyInstance Class

Syntax

C++

class OdBmFamilyInstance : public OdBmInsertableInst;

Description

This class represents an instance of a family type.

Class Hierarchy

File: BmFamilyInstance.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)
getAnalyticalBottomPlaneId	Returns this family instance's analytical bottom plane identifier.
getAnalyticalTopPlaneId	Returns this family instance's analytical top plane identifier.
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)
getAssocSketchPlaneId	Returns this family instance's associated sketch plane id.
getBBox	Calls the getBBox method of the related OdBmElementHeader. (Inherited from OdBmElement)
getBaseConnectorManager	Returns this family instance's connector manager from file.
getBaseDesignOptionId	Returns the Id of Design Option which was read from a file. (Inherited from OdBmElement)
getBaseHostId	(Inherited from OdBmInsertableInst)
getBaseStructType	Retrieves the structural type of the instance.
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)
getCreatedPhaseId	Returns the created phase id of this element. (Inherited from OdBmElement)
getCurveDriver	Returns the curve driver for this family instance.
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)
getDesignPropManager	Returns the design property manager for this family instance.
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)
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)
getElevation	(Inherited from OdBmInsertableInst)
getExplicitHostIds	(Inherited from OdBmInsertableInst)
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)
getExtraHostIds	(Inherited from OdBmInsertableInst)
getFacingOrientation	Returns instance facing orientation vector.
getFamId	Returns the family id of this element. (Inherited from OdBmElement)
getFamInstSpec	Returns this family instance's specs.
getFamInstUserData	Returns this family instance's user data.
getFamilyName	Returns the family name as OdString value. (Inherited from OdBmElement)
getFamilySymbolId	Returns FamilySymbol id of FamilyIntance.
getFilterElement(const OdBm::BuiltInParameter::Enum&)	This is the overview for the getFilterElement method overload.
getFlippedFromToRoom	Checks whether applicable objects have flipped "From room" and "To room" settings.
getFlippedX	Checks if the X-axis is flipped.
getFlippedY	Checks if the Y-axis is flipped.
getGInstanceId	(Inherited from OdBmInstance)
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)
getHandOrientation	Returns instance hand orientation vector.
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)
getHostId	It is using to implement HOST_ID_PARAM
getHostParam	(Inherited from OdBmInsertableInst)
getInplaceInsertionHelper	Returns this family instance's inplace insertion helper.
getInsertOrientation	Returns the insert orientation of this family instance.
getInstDormant	Checks if this family instance is dormant.
getInstOrigin	Returns the instance origin.
getInstanceInfo	(Inherited from OdBmInstance)
getInstanceParams	Returns the parameters of this instance.
getIntParams	Returns the IntParams of this element. (Inherited from OdBmElement)
getInvisible	Checks if this family instance is invisible.
getLeaders	Returns an array of leaders.
getListParams	Retrieves the list of parameters. (Inherited from OdBmObject)
getLocked	Checks if this element is locked. (Inherited from OdBmElement)
getMasterSymbolId	Returns this family instance's master symbol id.
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)
getObjectIdParams	Returns the ObjectIdParams of this element. (Inherited from OdBmElement)
getOffsetPosArr	Returns the offset position array.
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)
getOwnerElemId	Returns this family instance's owner element id.
getOwningElementId	Calls the getOwningElementId method of the related OdBmElemRec. remarks Throws eNotHandled if this element is null. (Inherited from OdBmElement)
getPOFDriver	Returns the POF driver for this family instance.
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)
getPartitionId	Calls the getPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdBmObject)
getPersistentReactors	Retrieves all the persistent reactors from the element. (Inherited from OdTfObject)
getPosRelToGrid	Returns this family instance's position relative to grid.
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.
getRefDir	Returns the reference direction for this instance.
getRefs	Returns the references of this family instance.
getRegenHistory	Calls the getRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
getRoomBounding	Checks if the room bounding is turned on.
getScheduleOnlyLevelId
getShortDescriptiveName	Returns the descriptive element name as OdString value. (Inherited from OdBmElement)
getStringParams	Returns the StringParams of this element. (Inherited from OdBmElement)
getStructUsage	Returns the structural usage of the instance.
getSubComponentIds	Returns an array of subcomponents for the current family instance.
getSubInstancesTable	Returns a table of subinstances for this family instace.
getSubentPathsAtGsMarker	(Inherited from OdBmElement)
getSuperInstanceId	Returns the super instance of this family instance element.
getTransform	Returns transformation matrix of the instance. (Inherited from OdBmInstance)
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)
getUseOffsetPos	Checks the value of the flag to use offset position.
getVersionGuid	Returns the unique identifier for the element from the database. (Inherited from OdBmElement)
getVertical	Checks if this family instance is vertical.
getViewRules	Calls the getViewRules method of the related OdBmElementHeader. (Inherited from OdBmElement)
getVisibility	Checks the visibility property value for this instance.
getWorkPlaneBased	Checks if this family instance is based on a work plane.
getWorkPlaneFlipped	Checks if the work plane is flipped for this family instance.
getWorksetId	Returns the Id of the Workset which owns the element. (Inherited from OdBmElement)
getZAxis	Returns the Z-axis vector for this instance.
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)
isCurtainPanel	Returns true if FamilyInstance is Curtain Panel.
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)
isMirrored	Checks if the family instance is mirrored.
isMullion	Returns true if FamilyInstance is Mullion.
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)
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)
set(const OdGePoint3d&, const OdBmObjectId&, OdBm::StructuralType::Enum)	This is the overview for the set method overload.
setAbFlags4Bytes	Calls the setAbFlags4Bytes method of the related OdBmElementHeader. (Inherited from OdBmElement)
setAnalyticalBottomPlaneId	Sets an analytical bottom plane for this family instance.
setAnalyticalTopPlaneId	Sets an analytical top plane for this family instance.
setAssocLevelId	Sets the AssocLevelId for this element. (Inherited from OdBmElement)
setAssocSketchPlaneId	Associates a sketch plane with this family instance.
setBBox	Calls the setBBox method of the related OdBmElementHeader. (Inherited from OdBmElement)
setBaseDesignOptionId	Sets the Id of Base Design Option. (Inherited from OdBmElement)
setBaseStructType	Sets the new structural type of the instance.
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)
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)
setFamInstSpec	Sets the specs for this family instance.
setFamInstUserData	Sets user data for this family instance.
setFlippedFromToRoom	Flips the "from room" and "to room" settings for applicable objects, if the passed parameter is true.
setFlippedX	Flips X-axis depending on the parameter value.
setFlippedY	Flips Y-axis depending on the parameter value.
setGInstanceId	(Inherited from OdBmInstance)
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)
setInstDormant	Sets a new value for the flag that checks whether the instance is dormant.
setInstOrigin	Sets an origin for this instance.
setInstanceInfo	(Inherited from OdBmInstance)
setInstanceParams	Sets the instance parameters for this instance.
setIntParams	Sets the IntParams for this element. (Inherited from OdBmElement)
setInvisible	Sets the invisibility flag for this family instance.
setLeaders	Sets an array of leaders.
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)
setObjectIdParams	Sets the ObjectIdParams for this element. (Inherited from OdBmElement)
setOffsetPosArr	Sets the offset position array.
setOwnerDBViewId	Sets the owner database view id for this element. (Inherited from OdBmElement)
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.
setParents	Calls the setParents method of the related OdBmElementHeader. (Inherited from OdBmElement)
setPartitionId	Calls the setPartitionId method of the related OdBmElemRec. (Inherited from OdBmElement)
setPosRelToGrid	Sets this family's position relative to grid.
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.
setRefDir	Sets the reference direction for this instance.
setRefs	Sets the references for this family instance.
setRegenHistory	Calls the setRegenHistory method of the related OdBmElementHeader. (Inherited from OdBmElement)
setRoomBounding	Sets a new value to the room bounding flag.
setRotation	Rotates the FamilyInstance
setScheduleOnlyLevelId
setStringParams	Sets the StringParams for this element. (Inherited from OdBmElement)
setStructUsage	Sets the structural usage for this family instance.
setSuperInstanceId	Sets the super instance for this family instance element.
setSymbolId	Sets FamilySymbol id of FamilyIntance.
setUnplacedOwnerId	Sets the unplaced owner id for this element. (Inherited from OdBmElement)
setUseOffsetPos	Sets a new value to the flag to use offset position.
setViewRules	Calls the setViewRules method of the related OdBmElementHeader. (Inherited from OdBmElement)
setVisibility	Sets the visibility property value for this instance.
setWorkPlaneBased	Sets a new value to the flag that checks if this instance is based on a work plane.
setWorkPlaneFlipped	Sets a new value for the flag that checks whether the work plane is flipped.
setZAxis	Sets the Z-axis vector for this instance.
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

OdBmFamilyInstance Methods

Relief for ODA Team in Ukraine