OdBmFamilyInstance Class

Class Hierarchy

Syntax

C++

class OdBmFamilyInstance : public OdBmInsertableInst;

File

BmFamilyInstance.h

Description

This class represents an instance of a family type.

Group

Family Classes

OdBmFamilyInstance Methods

getAnalyticalBottomPlaneId	Returns this family instance's analytical bottom plane identifier.
getAnalyticalTopPlaneId	Returns this family instance's analytical top plane identifier.
getAssocSketchPlaneId	Returns this family instance's associated sketch plane id.
getBaseConnectorManager	Returns this family instance's connector manager from file.
getBaseStructType	Retrieves the structural type of the instance.
getCurveDriver	Returns the curve driver for this family instance.
getDesignPropManager	Returns the design property manager for this family instance.
getFamilySymbolId	Returns FamilySymbol id of FamilyIntance.
getFamInstSpec	Returns this family instance's specs.
getFamInstUserData	Returns this family instance's user data.
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.
getHostId	It is using to implement HOST_ID_PARAM
getInplaceInsertionHelper	Returns this family instance's inplace insertion helper.
getInsertOrientation	Returns the insert orientation of this family instance.
getInstanceParams	Returns the parameters of this instance.
getInstDormant	Checks if this family instance is dormant.
getInstOrigin	Returns the instance origin.
getInvisible	Checks if this family instance is invisible.
getLeaders	Returns an array of leaders.
getMasterSymbolId	Returns this family instance's master symbol id.
getOffsetPosArr	Returns the offset position array.
getOwnerElemId	Returns this family instance's owner element id.
getPOFDriver	Returns the POF driver for this family instance.
getPosRelToGrid	Returns this family instance's position relative to grid.
getRefDir	Returns the reference direction for this instance.
getRefs	Returns the references of this family instance.
getRoomBounding	Checks if the room bounding is turned on.
getScheduleOnlyLevelId
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.
getSuperInstanceId	Returns the super instance of this family instance element.
getUseOffsetPos	Checks the value of the flag to use offset position.
getVertical	Checks if this family instance is vertical.
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.
getZAxis	Returns the Z-axis vector for this instance.
isCurtainPanel	Returns true if FamilyInstance is Curtain Panel.
isMirrored	Checks if the family instance is mirrored.
isMullion	Returns true if FamilyInstance is Mullion.
set	Sets the data of FamilyInstance
set	Sets the data of FamilyInstance
set	Sets the data of FamilyInstance
set	Sets the data of FamilyInstance
set	Sets the data of FamilyInstance
setAnalyticalBottomPlaneId	Sets an analytical bottom plane for this family instance.
setAnalyticalTopPlaneId	Sets an analytical top plane for this family instance.
setAssocSketchPlaneId	Associates a sketch plane with this family instance.
setBaseStructType	Sets the new structural type of the instance.
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.
setInstanceParams	Sets the instance parameters for this instance.
setInstDormant	Sets a new value for the flag that checks whether the instance is dormant.
setInstOrigin	Sets an origin for this instance.
setInvisible	Sets the invisibility flag for this family instance.
setLeaders	Sets an array of leaders.
setOffsetPosArr	Sets the offset position array.
setPosRelToGrid	Sets this family's position relative to grid.
setRefDir	Sets the reference direction for this instance.
setRefs	Sets the references for this family instance.
setRoomBounding	Sets a new value to the room bounding flag.
setRotation	Rotates the FamilyInstance
setScheduleOnlyLevelId
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.
setUseOffsetPos	Sets a new value to the flag to use offset position.
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.

Send feedback about this topic