API Reference > Classes > Family Classes > OdBmFamilyInstance Class
OdBmFamilyInstance Class
OdBmFamilyInstanceOdBmFamilyInstanceOdBmFamilyInstanceOdBmFamilyInstanceOdBmFamilyInstanceOdBmFamilyInstance
Syntax
C++
class OdBmFamilyInstance : public OdBmInsertableInst;

BmFamilyInstance.h

This class represents an instance of a family type. 

 

OdBmObject Class
 
Name 
Description 
 
A destructor for the BimRv object. 
 
Name 
Description 
 
Adds a new persistent reactor object to the element's reactor list.  
 
Adds a new transient reactor object to the element's reactor list.  
 
Retrieves the object's owner object.  
 
Retrieves all the persistent reactors from the element.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves all the transient reactors from the element.  
 
Retrieves whether a specified persistent reactor object is attached to the element.  
 
Removes a specified persistent reactor object from the element's reactor list.  
 
Removes a specified transient reactor object from the element's reactor list.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
OdBmObject Class
 
Name 
Description 
 
Adds a new persistent reactor object to the element's reactor list.  
 
Adds a new transient reactor object to the element's reactor list.  
 
Increments the counter of references to the object. 
 
Clones the object.
 
 
Retrieves the related database object.
 
 
Retrieves the drawable type of the object.
 
 
Returns a WCS bounding box that represents the extents of this object.
 
 
Retrieves the list of built-in parameters.
 
 
Retrieves the object's owner object.  
 
Retrieves all the persistent reactors from the element.  
 
Retrieves the array of object's properties.
 
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves all the transient reactors from the element.  
 
Retrieves graphical system cache associated with the object.
 
 
Retrieves whether a specified persistent reactor object is attached to the element.  
 
id 
Retrieves the object's identifier in the associated database.
 
 
Retrieves whether the object is persistent or not.
 
 
Retrieves the current quantity of references to the object.
 
 
Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed. 
 
Removes a specified persistent reactor object from the element's reactor list.  
 
Removes a specified transient reactor object from the element's reactor list.  
 
Applies the default properties of the specified database to this entity.
 
 
Assigns the specified OdGsCache to this object.
 
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Retrieves the current regeneration support flags set for the object.
 
 
Sets the vectorization attributes of the object, and returns its attribute flags.
 
 
Called by setDatabaseDefaults() after the values are set.
 
 
Implements viewport-dependent rendering.
 
 
Implements the mechanism for rendering the object.
 
OdBmElement Class
 
Name 
Description 
 
Adds a cell to the element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Adds a parameter to an element.
 
 
Throws an exception if this object is not open OdDb::kForNotify. 
 
Throws an exception if this object is not open OdDb::kForRead. 
 
Throws an exception if this object is not open OdDb::kForWrite, and controls automatic *undo* and notification of modifications. 
 
Returns database associated with this element as a pointer to the OdBmDatabase object. 
 
This is getAbFlags4Bytes, a member of class OdBmElement. 
 
Returns the Id of the assembly to which the element belongs. 
 
This is getAssocLevelId, a member of class OdBmElement. 
 
Returns the Id of Design Option which was read from a file. 
 
This is getBBox, a member of class OdBmElement. 
 
This is getCellList, a member of class OdBmElement. 
 
This is getClassDef, a member of class OdBmElement. 
 
This is getConstrInfo, a member of class OdBmElement. 
 
This is getCreatedPhaseId, a member of class OdBmElement. 
 
This is getDatabase, a member of class OdBmElement. 
 
This is getDemolishedPhaseId, a member of class OdBmElement. 
 
Returns the Id of Design Option. 
 
This is getDoubleParams, a member of class OdBmElement. 
 
This is getDummy, a member of class OdBmElement. 
 
This is getDynamicObject, a member of class OdBmElement. 
 
Returns the element name as OdString value. 
 
This is getElemRec, a member of class OdBmElement. 
 
Returns all entities in the element. 
 
Returns the entity in the element by specified GUID.
 
 
This is getFamId, a member of class OdBmElement. 
 
Returns the family name as OdString value. 
 
This is getFilterElement, a member of class OdBmElement. 
 
This is getFilterElement, a member of class OdBmElement. 
 
This is getGeometry, a member of class OdBmElement. 
 
Returns the part of geometry which passes the element settings.
 
 
Returns geometry extents of this element as an object of OdGeExtents3d class.
 
 
This is getGeomSteps, a member of class OdBmElement. 
 
This is getGeomTable, a member of class OdBmElement. 
 
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.
 
 
This is getHeader, a member of class OdBmElement. 
 
Returns the Id of Category taken from Header. 
 
This is getHistory, a member of class OdBmElement. 
 
This is getIntParams, a member of class OdBmElement. 
 
This is getLocked, a member of class OdBmElement. 
 
This is getMiscId, a member of class OdBmElement. 
 
This is getMoribund, a member of class OdBmElement. 
 
This is getObjectIdParams, a member of class OdBmElement. 
 
This is getOwnerDBViewId, a member of class OdBmElement. 
 
This is getOwningElementId, a member of class OdBmElement. 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
Retrieves a parameter value from an element using given parameter id.
 
 
deteails Retrieves a parameter value from an element using given parameter id.
 
 
This is getParents, a member of class OdBmElement. 
 
This is getPartitionId, a member of class OdBmElement. 
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
Retrieves the object's property value.  
 
This is getRegenHistory, a member of class OdBmElement. 
 
Returns the descriptive element name as OdString value. 
 
This is getStringParams, a member of class OdBmElement. 
 
This is getSubentPathsAtGsMarker, a member of class OdBmElement. 
 
Returns the element type id if available. 
 
Returns the element's type name as OdString value. 
 
Returns the unique identifier for the element from the database. 
 
This is getUnplacedOwnerId, a member of class OdBmElement. 
 
This is getViewRules, a member of class OdBmElement. 
 
Returns the Id of the Workset which owns the element. 
 
Checks if the element has DesignPropertyManager.  
 
This is highlight, a member of class OdBmElement. 
 
Returns true if this element has a 'Annotation' category type. 
 
Returns true if this element could be clipped
 
 
Returns true if and only this object is a *database* -resident object. 
 
Retrieves whether the Edit mode is enabled for the database.  
 
Returns true if and only if this element is a part of a family. 
 
Returns true if and only if this object has not been *closed* since it was created. 
 
Returns true if this element could be sectioned 
 
Checks if this element is visible on the specified view.
 
 
Returns database objects's id 
 
Returns the ID of the element's owner as an OdBmObjectId object. 
 
Returns the ID of the element's owning element as an OdBmObjectId object. 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
Pops a parameter with given id from an element.
 
 
This is setAbFlags4Bytes, a member of class OdBmElement. 
 
This is setAssocLevelId, a member of class OdBmElement. 
 
Sets the Id of Base Design Option.
 
 
This is setBBox, a member of class OdBmElement. 
 
This is setCellList, a member of class OdBmElement. 
 
This is setClassDef, a member of class OdBmElement. 
 
This is setConstrInfo, a member of class OdBmElement. 
 
This is setCreatedPhaseId, a member of class OdBmElement. 
 
This is setDatabase, a member of class OdBmElement. 
 
This is setDemolishedPhaseId, a member of class OdBmElement. 
 
This is setDoubleParams, a member of class OdBmElement. 
 
This is setDummy, a member of class OdBmElement. 
 
Change EdimMode state for the element.
 
 
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
 
 
This is setFamId, a member of class OdBmElement. 
 
This is setGeomSteps, a member of class OdBmElement. 
 
This is setGeomTable, a member of class OdBmElement. 
 
This is setHistory, a member of class OdBmElement. 
 
This is setIntParams, a member of class OdBmElement. 
 
This is setLocked, a member of class OdBmElement. 
 
This is setMiscId, a member of class OdBmElement. 
 
This is setMoribund, a member of class OdBmElement. 
 
This is setObjectIdParams, a member of class OdBmElement. 
 
This is setOwnerDBViewId, a member of class OdBmElement. 
 
This is setOwningElementId, a member of class OdBmElement. 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
Sets a value to a parameter by it's id.
 
 
This is setParents, a member of class OdBmElement. 
 
This is setPartitionId, a member of class OdBmElement. 
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
Sets a new value for the object's property.  
 
This is setRegenHistory, a member of class OdBmElement. 
 
This is setStringParams, a member of class OdBmElement. 
 
This is setUnplacedOwnerId, a member of class OdBmElement. 
 
This is setViewRules, a member of class OdBmElement. 
 
The method is used to highlight an element. 
 
Called by setDatabaseDefaults() after the values are set.
 
OdBmInstance Class
 
Name 
Description 
 
This is getGInstanceId, a member of class OdBmInstance. 
 
This is getInstanceInfo, a member of class OdBmInstance. 
 
This is getTransform, a member of class OdBmInstance. 
 
This is setGInstanceId, a member of class OdBmInstance. 
 
This is setInstanceInfo, a member of class OdBmInstance. 
OdBmInsertableInst Class
 
Name 
Description 
 
This is getBaseHostId, a member of class OdBmInsertableInst. 
 
This is getElevation, a member of class OdBmInsertableInst. 
 
This is getExplicitHostIds, a member of class OdBmInsertableInst. 
 
This is getExtraHostIds, a member of class OdBmInsertableInst. 
 
This is getHostParam, a member of class OdBmInsertableInst. 
OdBmFamilyInstance Class
 
Name 
Description 
 
This is getAnalyticalBottomPlaneId, a member of class OdBmFamilyInstance. 
 
This is getAnalyticalTopPlaneId, a member of class OdBmFamilyInstance. 
 
This is getAssocSketchPlaneId, a member of class OdBmFamilyInstance. 
 
Retrieves the structural type of the instance.
 
 
This is getConnectorManager, a member of class OdBmFamilyInstance. 
 
This is getCurveDriver, a member of class OdBmFamilyInstance. 
 
This is getDesignPropManager, a member of class OdBmFamilyInstance. 
 
Returns FamilySymbol of FamilyIntance. This FamilySymbol represents type of the FamilyIntance.
 
 
This is getFamInstSpec, a member of class OdBmFamilyInstance. 
 
This is getFamInstUserData, a member of class OdBmFamilyInstance. 
 
This is getFlippedFromToRoom, a member of class OdBmFamilyInstance. 
 
This is getFlippedX, a member of class OdBmFamilyInstance. 
 
This is getFlippedY, a member of class OdBmFamilyInstance. 
 
It is using to implement HOST_ID_PARAM 
 
This is getInplaceInsertionHelper, a member of class OdBmFamilyInstance. 
 
This is getInsertOrientation, a member of class OdBmFamilyInstance. 
 
This is getInstanceParams, a member of class OdBmFamilyInstance. 
 
This is getInstDormant, a member of class OdBmFamilyInstance. 
 
This is getInstOrigin, a member of class OdBmFamilyInstance. 
 
This is getInvisible, a member of class OdBmFamilyInstance. 
 
This is getLeaders, a member of class OdBmFamilyInstance. 
 
This is getMasterSymbolId, a member of class OdBmFamilyInstance. 
 
This is getOffsetPosArr, a member of class OdBmFamilyInstance. 
 
This is getOwnerElemId, a member of class OdBmFamilyInstance. 
 
This is getPOFDriver, a member of class OdBmFamilyInstance. 
 
This is getPosRelToGrid, a member of class OdBmFamilyInstance. 
 
This is getRefDir, a member of class OdBmFamilyInstance. 
 
This is getRefPnt, a member of class OdBmFamilyInstance. 
 
This is getRefs, a member of class OdBmFamilyInstance. 
 
This is getRoomBounding, a member of class OdBmFamilyInstance. 
 
This is getScheduleOnlyLevelId, a member of class OdBmFamilyInstance. 
 
This is getStructUsage, a member of class OdBmFamilyInstance. 
 
Returns an array of subcomponents for the current family instance.
 
 
This is getSubInstancesTable, a member of class OdBmFamilyInstance. 
 
This is getSuperInstanceId, a member of class OdBmFamilyInstance. 
 
This is getUseOffsetPos, a member of class OdBmFamilyInstance. 
 
This is getVertical, a member of class OdBmFamilyInstance. 
 
This is getVisibility, a member of class OdBmFamilyInstance. 
 
This is getWorkPlaneBased, a member of class OdBmFamilyInstance. 
 
This is getWorkPlaneFlipped, a member of class OdBmFamilyInstance. 
 
This is getZAxis, a member of class OdBmFamilyInstance. 
 
Returns true if FamilyInstance is Curtain Panel. 
 
Returns true if FamilyInstance is Mullion. 
 
set 
Sets the data of FamilyInstance
 
 
set 
Sets the data of FamilyInstance
 
 
set 
Sets the data of FamilyInstance
 
 
This is setAnalyticalBottomPlaneId, a member of class OdBmFamilyInstance. 
 
This is setAnalyticalTopPlaneId, a member of class OdBmFamilyInstance. 
 
This is setAssocSketchPlaneId, a member of class OdBmFamilyInstance. 
 
Sets the new structural type of the instance.
 
 
This is setFamInstSpec, a member of class OdBmFamilyInstance. 
 
This is setFamInstUserData, a member of class OdBmFamilyInstance. 
 
This is setFlippedFromToRoom, a member of class OdBmFamilyInstance. 
 
This is setFlippedX, a member of class OdBmFamilyInstance. 
 
This is setFlippedY, a member of class OdBmFamilyInstance. 
 
This is setInstanceParams, a member of class OdBmFamilyInstance. 
 
This is setInstDormant, a member of class OdBmFamilyInstance. 
 
This is setInstOrigin, a member of class OdBmFamilyInstance. 
 
This is setInvisible, a member of class OdBmFamilyInstance. 
 
This is setLeaders, a member of class OdBmFamilyInstance. 
 
This is setOffsetPosArr, a member of class OdBmFamilyInstance. 
 
This is setPosRelToGrid, a member of class OdBmFamilyInstance. 
 
This is setRefDir, a member of class OdBmFamilyInstance. 
 
This is setRefPnt, a member of class OdBmFamilyInstance. 
 
This is setRefs, a member of class OdBmFamilyInstance. 
 
This is setRoomBounding, a member of class OdBmFamilyInstance. 
 
Rotates the FamilyInstance
 
 
This is setScheduleOnlyLevelId, a member of class OdBmFamilyInstance. 
 
This is setStructUsage, a member of class OdBmFamilyInstance. 
 
This is setSuperInstanceId, a member of class OdBmFamilyInstance. 
 
This is setUseOffsetPos, a member of class OdBmFamilyInstance. 
 
This is setVisibility, a member of class OdBmFamilyInstance. 
 
This is setWorkPlaneBased, a member of class OdBmFamilyInstance. 
 
This is setWorkPlaneFlipped, a member of class OdBmFamilyInstance. 
 
This is setZAxis, a member of class OdBmFamilyInstance. 
OdBmObject Class
Name 
Description 
This is nested type OdBmObject::ItemIndexType. 
This is nested type OdBmObject::PropertyIndexType. 
Copyright (c) 2002-2020. Open Design Alliance. All rights reserved.