OdBmFamilyBase Class

Class Hierarchy

Syntax

C++

class OdBmFamilyBase : public OdBmElement;

File

BmFamilyBase.h

Description

This is the base class for family classes.

Group

Database Classes

OdBmFamilyBase Methods

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.
getBeamCutbackForColumn	Retrieves the current beam cutback for a column.
getBraceRepType	Retrieves the current brace representation type.
getCanHostRebar	Retrieves whether the family can host rebar.
getContentProtected	Retrieves whether the family's content is protected.
getCouldAutojoin	Retrieves whether a data can be auto-join to the family.
getCurveBased	Retrieves whether the family is curve based.
getCutback	Retrieves whether the family is a cutback.
getDatabase2	Retrieves a BimRv database object associated with the family.
getDBViewInfos	Retrieves the array of DB Views.
getDeletableElements	Retrieves the identifiers of deletable elements for the family.
getDumpSymName	Retrieves the dump symbolic name.
getElecKeepAnnotationOrientation	Retrieves whether the family maintains annotation orientation.
getElevationMarkBody	Retrieves whether the family uses elevation mark.
getEnableCuttingInViews	Retrieves whether the family enables cutting in views.
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.
getFamilyNameKeyText	Retrieves the text of the family name key.
getFamilyParams	Retrieves the current parameters of the family.
getFamilySymbolDependentObjects
getFamilyTypes	Retrieves the family types.
getForceProperMirroring	Retrieves whether the family is forsed to proper mirroring.
getFromADPx	Retrieves whether the family is from ADPX or not.
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.
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.
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.
getLockedParameterIdsForDirectManipulation	Retrieves the array that contains identifiers of the locked parameters for direct manipulation.
getName	Retrieves the family name.
getNextAbsorbedIndex	Retrieves the next absorbed index for the family.
getOldCurveElemsWithBadSketchAndSP	Retrieves the array that contains identifiers of the old curves with bad sketches.
getOmniClassCode	Retrieves the omniclass number.
getOwnerSymbolId	Retrieves the owner symbol identifier.
getPanelConfig	Retrieves the current panel configuration for the family.
getPartType	Retrieves the current part type of the family.
getPath	Retrieves the current path to the family.
getPredefinedLimitIdx	Retrieves the current predefined limit for the family.
getProfileFamDefinition	Retrieves the current profile families definition.
getProfileFamUsage	Retrieves the current profile families.
getProtectionAccessKey	Retrieves the current projection access key.
getProteinRenderType	Retrieves the current protein render type.
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.
getShouldStayParametric	Retrieves whether the family should stay a parametric family.
getStretchingDisallowed	Retrieves whether the family disallows stretching.
getStructConnectionApplyTo	Retrieves the connection on which the family should be connected to.
getStructHiddenViewDisplayType	Retrieves the current display type of a hidden view.
getStructuralCodeName	Retrieves the current structural code name of the family.
getStructuralMaterialType	Retrieves the current physical material type of the family.
getStructUseCap	Retrieves whether the family is using cap.
getSymbolicRepType	Retrieves the current symbolic representation type of the family.
getTagCurveAttachmentProportion	Retrieves the current curve attachment point tag.
getTrivialParamIds	Retrieves the array of trivial parameter identifiers for the family.
getUsePreCutShape	Retrieves whether the family shows pre-cut in plan view
isRegistred	Checks whether a specified identifier is registered in the family.
registerId	Registers a specified identifier in the family.
setAppVersionAtInitialLoad	Sets a new application version at initial loading.
setAppVersionAtLoad	Sets a new application version at loading.
setBeamCutbackForColumn	Sets a new beam cutback for a column.
setBraceRepType	Sets a new value of the brace representation type.
setDatabase2	Associates a specified BimRv database with the family.
setDBViewInfos	Sets a new array of DB Views for the family.
setDumpSymName	Sets a new dump symbolic name.
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.
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.
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).
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.
setName	Sets a new family name.
setNextAbsorbedIndex	Sets the next absorbed index for the family.
setOwnerSymbolId	Sets a new owner symbol Id.
setPanelConfig	Sets a new panel configuration value.
setPartType	Sets a new part type of the family.
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.
setProteinRenderType	Sets a new protein render type value.
setRenderModelType	Sets a new rendering model type for the family.
setRoundConnDimType	Sets a new round connector dimension type.
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.
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.

Send feedback about this topic