OdBmDBView Class

Class Hierarchy

Syntax

C++

class OdBmDBView : public OdBmElement;

File

BmDBView.h

Description

This is the base class for all types of OdBmDBViews.

Group

Database Classes

Public Methods

OdBmObject Class

	Name	Description
	~OdBmObject	A destructor for the BimRv object.

OdTfObject Methods

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.

OdBmObject Class

	Name	Description
	addPersistentReactor	Adds a new persistent reactor object to the element's reactor list.
	addReactor	Adds a new transient reactor object to the element's reactor list.
	addRef	Increments the counter of references to the object.
	clone	Clones the object.
	database	Retrieves the related database object.
	drawableType	Retrieves the drawable type of the object.
	getGeomExtents	Returns a WCS bounding box that represents the extents of this object.
	getListParams	Retrieves the list of built-in parameters.
	getOwner	Retrieves the object's owner object.
	getPersistentReactors	Retrieves all the persistent reactors from the element.
	getProperties	Retrieves the array of object's properties.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getTransientReactors	Retrieves all the transient reactors from the element.
	gsNode	Retrieves graphical system cache associated with the object.
	hasPersistentReactor	Retrieves whether a specified persistent reactor object is attached to the element.
	id	Retrieves the object's identifier in the associated database.
	isPersistent	Retrieves whether the object is persistent or not.
	numRefs	Retrieves the current quantity of references to the object.
	release	Decrements the counter of references to the object. When the counter becomes equal to zero the object is destroyed.
	removePersistentReactor	Removes a specified persistent reactor object from the element's reactor list.
	removeReactor	Removes a specified transient reactor object from the element's reactor list.
	setDatabaseDefaults	Applies the default properties of the specified database to this entity.
	setGsNode	Assigns the specified OdGsCache to this object.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	subRegenSupportFlags	Retrieves the current regeneration support flags set for the object.
	subSetAttributes	Sets the vectorization attributes of the object, and returns its attribute flags.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
	subViewportDraw	Implements viewport-dependent rendering.
	subWorldDraw	Implements the mechanism for rendering the object.

OdBmElement Class

	Name	Description
	addCell	Adds a cell to the element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	addParam	Adds a parameter to an element.
	assertNotifyEnabled	Throws an exception if this object is not open OdDb::kForNotify.
	assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead.
	assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications.
	database	Returns database associated with this element as a pointer to the OdBmDatabase object.
	getAbFlags4Bytes	This is getAbFlags4Bytes, a member of class OdBmElement.
	getAssemblyInstanceId	Returns the Id of the assembly to which the element belongs.
	getAssocLevelId	This is getAssocLevelId, a member of class OdBmElement.
	getBaseDesignOptionId	Returns the Id of Design Option which was read from a file.
	getBBox	This is getBBox, a member of class OdBmElement.
	getCellList	This is getCellList, a member of class OdBmElement.
	getClassDef	This is getClassDef, a member of class OdBmElement.
	getConstrInfo	This is getConstrInfo, a member of class OdBmElement.
	getCreatedPhaseId	This is getCreatedPhaseId, a member of class OdBmElement.
	getDatabase	This is getDatabase, a member of class OdBmElement.
	getDemolishedPhaseId	This is getDemolishedPhaseId, a member of class OdBmElement.
	getDesignOptionId	Returns the Id of Design Option.
	getDoubleParams	This is getDoubleParams, a member of class OdBmElement.
	getDummy	This is getDummy, a member of class OdBmElement.
	getDynamicObject	This is getDynamicObject, a member of class OdBmElement.
	getElementName	Returns the element name as OdString value.
	getElemRec	This is getElemRec, a member of class OdBmElement.
	getESEntities	Returns all entities in the element.
	getESEntity	Returns the entity in the element by specified GUID.
	getFamId	This is getFamId, a member of class OdBmElement.
	getFamilyName	Returns the family name as OdString value.
	getFilterElement	This is getFilterElement, a member of class OdBmElement.
	getFilterElement	This is getFilterElement, a member of class OdBmElement.
	getGeometry	This is getGeometry, a member of class OdBmElement.
	getGeometry	Returns the part of geometry which passes the element settings.
	getGeomExtents	Returns geometry extents of this element as an object of OdGeExtents3d class.
	getGeomSteps	This is getGeomSteps, a member of class OdBmElement.
	getGeomTable	This is getGeomTable, a member of class 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.
	getHeader	This is getHeader, a member of class OdBmElement.
	getHeaderCategoryId	Returns the Id of Category taken from Header.
	getHistory	This is getHistory, a member of class OdBmElement.
	getIntParams	This is getIntParams, a member of class OdBmElement.
	getLocked	This is getLocked, a member of class OdBmElement.
	getMiscId	This is getMiscId, a member of class OdBmElement.
	getMoribund	This is getMoribund, a member of class OdBmElement.
	getObjectIdParams	This is getObjectIdParams, a member of class OdBmElement.
	getOwnerDBViewId	This is getOwnerDBViewId, a member of class OdBmElement.
	getOwningElementId	This is getOwningElementId, a member of class OdBmElement.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParam	Retrieves a parameter value from an element using given parameter id.
	getParam	deteails Retrieves a parameter value from an element using given parameter id.
	getParents	This is getParents, a member of class OdBmElement.
	getPartitionId	This is getPartitionId, a member of class OdBmElement.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getProperty	Retrieves the object's property value.
	getRegenHistory	This is getRegenHistory, a member of class OdBmElement.
	getShortDescriptiveName	Returns the descriptive element name as OdString value.
	getStringParams	This is getStringParams, a member of class OdBmElement.
	getSubentPathsAtGsMarker	This is getSubentPathsAtGsMarker, a member of class OdBmElement.
	getTypeID	Returns the element type id if available.
	getTypeName	Returns the element's type name as OdString value.
	getUniqueId	Returns the unique identifier for the element from the database.
	getUnplacedOwnerId	This is getUnplacedOwnerId, a member of class OdBmElement.
	getViewRules	This is getViewRules, a member of class OdBmElement.
	getWorksetId	Returns the Id of the Workset which owns the element.
	hasDesignPropManager	Checks if the element has DesignPropertyManager.
	highlight	This is highlight, a member of class OdBmElement.
	isAnnotation	Returns true if this element has a 'Annotation' category type.
	isClippable	Returns true if this element could be clipped
	isDBRO	Returns true if and only this object is a database -resident object.
	isEditMode	Retrieves whether the Edit mode is enabled for the database.
	isInAFamily	Returns true if and only if this element is a part of a family.
	isNewObject	Returns true if and only if this object has not been closed since it was created.
	isSectionable	Returns true if this element could be sectioned
	isVisibleInView	Checks if this element is visible on the specified view.
	objectId	Returns database objects's id
	ownerId	Returns the ID of the element's owner as an OdBmObjectId object.
	owningElemId	Returns the ID of the element's owning element as an OdBmObjectId object.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	popParam	Pops a parameter with given id from an element.
	setAbFlags4Bytes	This is setAbFlags4Bytes, a member of class OdBmElement.
	setAssocLevelId	This is setAssocLevelId, a member of class OdBmElement.
	setBaseDesignOptionId	Sets the Id of Base Design Option.
	setBBox	This is setBBox, a member of class OdBmElement.
	setCellList	This is setCellList, a member of class OdBmElement.
	setClassDef	This is setClassDef, a member of class OdBmElement.
	setConstrInfo	This is setConstrInfo, a member of class OdBmElement.
	setCreatedPhaseId	This is setCreatedPhaseId, a member of class OdBmElement.
	setDatabase	This is setDatabase, a member of class OdBmElement.
	setDemolishedPhaseId	This is setDemolishedPhaseId, a member of class OdBmElement.
	setDoubleParams	This is setDoubleParams, a member of class OdBmElement.
	setDummy	This is setDummy, a member of class OdBmElement.
	setEditMode	Change EdimMode state for the element.
	setESEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
	setFamId	This is setFamId, a member of class OdBmElement.
	setGeomSteps	This is setGeomSteps, a member of class OdBmElement.
	setGeomTable	This is setGeomTable, a member of class OdBmElement.
	setHistory	This is setHistory, a member of class OdBmElement.
	setIntParams	This is setIntParams, a member of class OdBmElement.
	setLocked	This is setLocked, a member of class OdBmElement.
	setMiscId	This is setMiscId, a member of class OdBmElement.
	setMoribund	This is setMoribund, a member of class OdBmElement.
	setObjectIdParams	This is setObjectIdParams, a member of class OdBmElement.
	setOwnerDBViewId	This is setOwnerDBViewId, a member of class OdBmElement.
	setOwningElementId	This is setOwningElementId, a member of class OdBmElement.
	setParam	Sets a value to a parameter.
	setParam	Sets a value to a parameter.
	setParam	Sets a value to a parameter.
	setParam	Sets a value to a parameter.
	setParam	Sets a value to a parameter.
	setParam	Sets a value to a parameter by it's id.
	setParam	Sets a value to a parameter by it's id.
	setParam	Sets a value to a parameter by it's id.
	setParam	Sets a value to a parameter by it's id.
	setParam	Sets a value to a parameter by it's id.
	setParents	This is setParents, a member of class OdBmElement.
	setPartitionId	This is setPartitionId, a member of class OdBmElement.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setProperty	Sets a new value for the object's property.
	setRegenHistory	This is setRegenHistory, a member of class OdBmElement.
	setStringParams	This is setStringParams, a member of class OdBmElement.
	setUnplacedOwnerId	This is setUnplacedOwnerId, a member of class OdBmElement.
	setViewRules	This is setViewRules, a member of class OdBmElement.
	subHighlight	The method is used to highlight an element.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.

OdBmDBView Class

	Name	Description
	cleanElemCache	Cleans arrays with prepared objects to draw. May be used to update a view after adding new elements to the database.
	getAdHocOverrides	Returns the AdHoc overrides object.
	getAmbientShadows	Returns visibility of ambient shadows on a view.
	getAnalysisDisplayStyleId	Returns the ID of the analysis display style associated with this view.
	getBackClipping	Returns the back clipping value.
	getBackDrawableElements	Returns the list of the background elements of the view.
	getBaseBackClipping	Returns the back clipping value that was read from the file.
	getBaseDesignOptionViewSettings	Returns the view's design settings base value.
	getCastShadows	Returns shadows visibility.
	getCategoryOverrides	Gets graphic overrides for a category in view.
	getColorFillSchemaSetting	Returns the settings of the color filling scheme.
	getCustomScaleName	Returns the name of the custom scale.
	getDbDrawingId	Returns the ID of the OdBmDBDrawing.
	getDBViewTypeId	Returns the ID of the view type.
	getDefaultTemplateId	Returns the ID of the view's default template.
	getDependentViewIds	Returns the array of IDs of the views that are dependent on this view.
	getDesignOptionViewSettings	Returns the view's design settings.
	getDetailDrawOrderMgr	Returns the draw order manager.
	getDetailLevel	Returns detail level value of elements in current view.
	getDirectContext3DHandleOverrides	This is getDirectContext3DHandleOverrides, a member of class OdBmDBView.
	getDisplayStyle	Returns Visual style of the current view.
	getDrawableElements	Returns the list of the non-annotated elements of the view.
	getDrawFilters	Returns the array of applied filters.
	getElementOverrides	Gets graphic overrides for an element in the view.
	getEnableSketchyLines	Returns flag of sketchy lines (jitter effect) of edges in current view.
	getExplicitlyHiddenElements	Returns the array of IDs of the elements that are explicitly hidden.
	getExtension	Returns value between 0 and 10 indicates how far a model line's endpoints extend beyond intersections. A value of 0 results in lines that meet at intersections. A value of 10 results in lines that extend well beyond intersections.
	getExtentElemId	Returns the ID of the element extent.
	getFilterOverrides	Returns the overrides that a filter applies to a view.
	getFilterOverrides	Gets graphic overrides for a filter in the view.
	getFixedSketchPlaneId	Returns the ID of the fixed sketch plane.
	getForceCustomViewScale	Returns 'true' if the view has a custom view scale.
	getFrontDrawableElements	Returns the list of the annotated elements of the view.
	getGenElemId	Returns the ID of the view level.
	getGraphicOverrides	Returns the graphics overrides of the view.
	getHasCustomScaleName	Returns 'true' if the view has a name of a custom scale.
	getHiddenElementsViewSettings	Returns the settings of the hidden elements of the view.
	getHideElementsMgr	Returns the manager of hidden elements.
	getIsTemplate	Returns 'true' if this view is a template view.
	getJitter	Returns value between 0 and 10 of the degree of variability in the sketched lines. A value of 0 results in straight lines without the sketched graphic style. A value of 10 results in multiple sketch lines.
	getLightSchemeId	Returns the ID of the light scheme.
	getModelDisplayMode	Returns the model display mode value.
	getNamed	Returns 'true' if the view has a name.
	getNonPropagatedTemplateParamIds	Returns the array of IDs of the parameters that will not be controlled by the view template.
	getOrigin	Returns view origin as a 3D point.
	getPartsVisibility	Returns the settings of displaying the parts in this view.
	getPointCloudOverrides	Returns the point cloud overrides.
	getPreviewVisibility	Returns preview visibility mode for a view.
	getPrimaryViewId	Returns the ID of the parent view if this view is dependent.
	getRetouchTable	Returns the retouch table.
	getRightDirection	Returns the direction towards the right side of the screen.
	getRvtLinkOverrides	Returns the link overrides.
	getScale	Returns the scale of the view.
	getSheetViewportElemIds	Returns the array of IDs of the viewport elements that are linked with this view and placed on the sheets.
	getShopDrawingAssemblyInstanceId	Returns the ID of the assembly instance to which the element belongs.
	getShowEdges	Returns visibility of edges in current view.
	getSilhouetteEdgesGStyleId	Returns a line styles that create a silhouette.
	getSketchPlaneId	Returns id of SketchPlane assigned to the view. remarks Returns OdBmObjectId::kNull for views which don't have a sketch.
	getTransparency	Returns transparency value of elements in current view.
	getUniqueDrawFilter	Gets unqiue draw filter by class.
	getUpDirection	Returns the direction towards the top of the screen.
	getViewDatabase	Returns pointer to view database.
	getViewDescription	Returns the view description.
	getViewDirection	Returns the direction towards the OdBmViewer.
	getViewDiscipline	Returns the view's disciplines.
	getViewDisplayMgr	Returns the view's display manager.
	getViewerId	Returns the ID of the OdBmViewer.
	getViewName	Returns the view name.
	getViewNameFormat	Returns a view format.
	getViewTemplateId	Returns the ID of the template that contains view parameters.
	getViewType	Returns a view type.
	getVisibleBackDrawableElements	Returns the list of visible background elements of the view.
	getVisibleDrawableElements	Returns the list of visible non-annotated elements of the view.
	getVisibleFrontDrawableElements	Returns the list of visible annotated elements of the view.
	getVisualStyle	Returns the visual style of the view.
	getWorksetVisibility	Gets visibility mode for a workset in this view.
	getWorksetVisibilityViewSettings	Returns visibility sittings of the view's workset.
	isElementClipped	Checks if an element is out of the current view's clip region.
	isElementVisible	Checks if an element is visible in the current view.
	isPerspective	Returns true if the view is perspective.
	IsWorksetVisible	Returns is the workset visible in this view.
	setAmbientShadows	Sets visibility of ambient shadows on a view.
	setCastShadows	Sets shadows visibility.
	setCategoryOverrides	Sets graphic overrides for a category in view.
	setDetailLevel	Sets detail level value of elements in current view.
	setDisplayStyle	Sets Visual style of the current view.
	setEnableSketchyLines	Sets flag of sketchy lines (jitter effect) of edges in current view.
	setExtension	Sets value between 0 and 10 to indicate how far a model line's endpoints extend beyond intersections. A value of 0 results in lines that meet at intersections. A value of 10 results in lines that extend well beyond intersections.
	setJitter	Sets the degree of variability in the sketched lines. A value of 0 results in straight lines without the sketched graphic style. A value of 10 results in multiple sketch lines.
	setPreviewVisibility	Sets preview visibility mode for a view.
	setShowEdges	Sets visibility of edges in current view.
	setSilhouetteEdgesGStyleId	Sets a line styles that create a silhouette.
	setTransparency	Sets transparency value of elements in current view.
	setUniqueDrawFilter	Sets unqiue draw filter by class.
	setViewDiscipline	Sets the view's discipline.
	setViewName	Sets the view name.
	setViewTemplateId	Sets the ID of the template that contains view parameters.
	setWorksetVisibility	Sets visibility mode for a workset in this view.

OdBmObject Nested Types

OdBmObject Class

Name	Description
ItemIndexType	This is nested type OdBmObject::ItemIndexType.
PropertyIndexType	This is nested type OdBmObject::PropertyIndexType.

Send feedback about this topic