OdDbViewport Class

Class Hierarchy

Syntax

C++

class OdDbViewport : public OdDbEntity;

File

DbViewport.h

Description

This class represents PaperSpace Viewport entities in an OdDbDatabase instance.

TD_Db

	Name	Description
	OdDbViewport	This is OdDbViewport, a member of class OdDbViewport.

OdDbViewport Enumerations

	Name	Description
	ShadePlotType	This is record OdDbViewport::ShadePlotType.
	StandardScaleType	This is record OdDbViewport::StandardScaleType.

OdDbViewport Methods

	Name	Description
	ambientLightColor	Retrieves the color of ambient light in this viewport.
	annotationScale	Retrieves a smart pointer to the annotation scale object of this viewport.
	backClipDistance	Returns the back clip distance of this Viewport object (DXF 44).
	background	Retrieves an identifier of the view background for this viewport.
	brightness	Retrieves the brightness value which affects the relative intensity of lights in this viewport.
	centerPoint	Returns the WCS center point of this Viewport object (DXF 10).
	circleSides	Returns the circle zoom percent of this Viewport object (DXF 72).
	contrast	Retrieves the contrast value which affects the intensity of ambient lights on other lights in this viewport.
	customScale	Returns the custom scale of this Viewport object.
	defaultLightingType	Retrieves the default lighting type for this viewport.
	dwgInFields	Reads the .dwg file data of this object.
	DWGMAP_DECLARE_MEMBERS	This is DWGMAP_DECLARE_MEMBERS, a member of class OdDbViewport.
	dwgOutFields	Writes the .dwg file data of this object.
	dxfInFields	Reads the .dxf file data of this object.
	dxfInFields_R12	Reads the .dxf file data specific to the R12 version of this object.
	dxfOutFields	Writes the .dxf file data of this object.
	dxfOutFields_R12	Writes the .dxf file data specific to the R12 version of this object.
	effectivePlotStyleSheet	Returns the plot style sheet name associated with this Viewport object.
	elevation	Returns the elevation of the UCS plane of this entity (DXF 146).
	erased	Notification function called whenever an object is erased or unerased.
	explodeGeometry	Explodes viewport geometry into a set of simpler entities.
	freezeLayersInViewport	Freezes the specified layers in this Viewport object (DXF 341)
	frontClipDistance	Returns the front clip distance of this Viewport object (DXF 43).
	getFrozenLayerList	Returns all layers that are frozen in this Viewport object.
	getLabelBlock	Retrieves an object identifier of the label block (OdDbBlockReference) associated with this viewport.
	getModelView	Retrieves the exterally referenced object identifier of the model view associated with this viewport.
	getSheetView	Retrieves an object identifier of a sheet view associated with this viewport.
	getUcs	Returns the origin, X-axis, and Y-Axis of the UCS associated with this Viewport object.
	gridIncrement	Returns the grid increment of this Viewport object (DXF 15).
	gridMajor	Retrieves the number of minor grid lines between each major grid line.
	gsView	Retrieves a pointer to a GS view associated with this viewport.
	height	Returns the height of this Viewport object (DXF 41).
	hiddenLinesRemoved	Returns true if and only if this Viewport object will have hidden lines removed during plotting. (DXF 90, bit 0x800).
	isBackClipOn	Returns true if and only if back clipping is on for this Viewport object (DXF 90, bit 0x04).
	isDefaultLightingOn	Checks whether default lighting is enabled for this viewport.
	isFastZoomOn	Returns true if and only if fast zooms are on for this Viewport object (DXF 90, bit 0x80).
	isFrontClipAtEyeOn	Returns true if and only if the front clipping plane passes through the camera (DXF 90, bit 0x10).
	isFrontClipOn	Returns true if and only if front clipping is on for this Viewport object (DXF 90, bit 0x02).
	isGridAdaptive	Checks whether the grid adapts to display fewer or more lines in the viewport than the value specified by the GRIDUNIT setting. An adaptive grid can be useful to avoid issues when a viewport is zoomed out too much and the grid becomes too dense, or on the contrary, when a viewport is zoomed in too much, there can be too few lines to display the grid.
	isGridBoundToLimits	Checks whether a grid is diplayed only inside the limits for the WCS and UCS in this viewport.
	isGridFollow	Checks whether the grid responds to dynamic UCS changes in this viewport.
	isGridOn	Returns true if and only if the grid is on for this Viewport object (DXF 90, bit 0x200).
	isGridSubdivisionRestricted	Checks whether grid subdivision is not allowed below the minor grid spacing in this viewport.
	isLayerFrozenInViewport	Returns true and only if the specified layer is frozen in this Viewport object.
	isLocked	Returns true if and only if scale factor of this Viewport object is locked (DXF 90, bit 0x4000).
	isNonRectClipOn	Returns true if and only if non-rectangular clipping is enabled for this Viewport object (DXF 90, bit 0x10000).
	isOn	Returns true if and only if this Viewport object is on (DXF 90, bit 0x20000).
	isPerspectiveOn	Returns true if and only if perspective is on for this Viewport object (DXF 90, bit 0x01).
	isSnapIsometric	Returns true if and only if isometric snap style is on for this Viewport object (DXF 90, bit 0x400).
	isSnapOn	Returns true if and only if the snap mode is on for this Viewport object (DXF 90, bit 0x100).
	isTransparent	Not implemented. The value returned is not saved to file. Always returns true.
	isUcsFollowModeOn	Returns true if and only if UCS follow mode is on for this Viewport object (DXF 90, bit 0x08).
	isUcsIconAtOrigin	Returns true if and only if the UCS icon is at the UCS origin for this Viewport object (DXF 90, bit 0x40).
	isUcsIconVisible	Returns true if and only if the UCS icon is visible for this Viewport object (DXF 90, bit 0x20).
	isUcsOrthographic	True if and only if the UCS associated with this Viewport object is orthographic with respect to UCSBASE (DXF 79).
	isUcsSavedWithViewport	Returns true if and only if the UCS that is associated with this Viewport object will become active with the activation of this Viewport object.
	lensLength	Returns the perspective mode lens length (in mm) of this Viewport object (DXF 42).
	modified	Notification function called whenever an object is opened in the OdDb::kForWrite mode, a function is called that could modify the contents of this object, and this object is now being closed.
	nonRectClipEntityId	Returns the Object ID of the clipping entity for this Viewport object (DXF 340).
	number	Returns the ID number of this Viewport object.
	plotAsRaster	Checks whether the viewport will plot raster output based on the viewport's current shade plot settings.
	plotStyleSheet	Returns the name of the plot style sheet applied to objects in this Viewport object (DXF 1).
	plotWireframe	Checks whether the viewport will plot vector output based on the viewport's current shade plot settings.
	removeHiddenLines	Sets this Viewport object to have hidden lines removed during plotting. (DXF 90, bit 0x800).
	removeLabelBlock	Removes the label block (OdDbBlockReference) associated with this viewport.
	removeModelView	Removes the model view association from this viewport.
	removeSheetView	Removes the sheet view association from this viewport.
	renderMode	Returns the render mode of this Viewport object (DXF 281).
	setAmbientLightColor	Sets the color of ambient light in this viewport.
	setAnnotationScale	Sets the annotation scale object for this viewport.
	setBackClipDistance	Sets the back distance of this Viewport object (DXF 44).
	setBackClipOff	Turns off back clipping for this Viewport object (DXF 90, bit 0x04).
	setBackClipOn	Turns on back clipping for this Viewport object (DXF 90, bit 0x04).
	setBackground	Sets the view background for this viewport.
	setBrightness	Sets the brightness value which affects the relative intensity of lights in this viewport.
	setCenterPoint	Sets the WCS center point of this Viewport object (DXF 10).
	setCircleSides	Sets the circle zoom percent of this Viewport object (DXF 72).
	setContrast	Sets the contrast value which affects the intensity of ambient lights on other lights in this viewport.
	setCustomScale	Sets the custom scale of this Viewport object.
	setDefaultLightingOn	Enables or disables default lighting for this viewport.
	setDefaultLightingType	Sets the default lighting type for this viewport.
	setElevation	Sets the elevation of the UCS plane of this Viewport object (DXF 146).
	setFastZoomOff	Sets fast zooms off for this Viewport object (DXF 90, bit 0x80).
	setFastZoomOn	Sets fast zooms on for this Viewport object (DXF 90, bit 0x80).
	setFrontClipAtEyeOff	Sets the front clipping plane to utilize the front clip distance (DXF 90, bit 0x10).
	setFrontClipAtEyeOn	Sets the front clipping plane to pass through the camera (DXF 90, bit 0x10).
	setFrontClipDistance	Sets the front clip distance of this Viewport object (DXF 43).
	setFrontClipOff	Turns off front clipping for this Viewport object (DXF 90, bit 0x02).
	setFrontClipOn	Turns on front clipping for this Viewport object (DXF 90, bit 0x02).
	setGridAdaptive	Specifies whether to adapt the grid display. An adaptive grid can be useful to avoid issues when a viewport is zoomed out too much and the grid becomes too dense, or on the contrary, when a viewport is zoomed in too much, there can be too few lines to display the grid.
	setGridBoundToLimits	Specifies whether to display a grid only inside the limits for the WCS and UCS in this viewport.
	setGridFollow	Specifies whether the grid should be redrawn according to dynamic UCS changes in this viewport.
	setGridIncrement	Sets the grid increment of this Viewport object (DXF 15).
	setGridMajor	Specifies the number of minor grid lines between each major grid line. For example, if the passed value is 10, a major grid line is displayed at every 10-th minor grid line.
	setGridOff	Sets the grid off for this Viewport object (DXF 90, bit 0x200).
	setGridOn	Sets the grid on for this Viewport object (DXF 90, bit 0x200).
	setGridSubdivisionRestricted	Specifies whether to restrict grid subdivision below the minor grid spacing in this viewport.
	setGsView	Associates a GS view with this viewport.
	setHeight	Sets the height of this Viewport object (DXF 41).
	setLabelBlock	Associates a label block (OdDbBlockReference) with this viewport.
	setLensLength	Sets the perspective mode lens length of this Viewport object (DXF 42).
	setLocked	Locks the scale factor of this Viewport object (DXF 90, bit 0x4000).
	setModelView	Associates a model view (defined by the passed external reference 'objId') with this viewport.
	setNonRectClipEntityId	Sets the Object ID of the clipping entity for this Viewport object (DXF 340).
	setNonRectClipOff	Sets non-rectangular clipping off for this Viewport object (DXF 90, bit 0x10000).
	setNonRectClipOn	Sets non-rectangular clipping on for this Viewport object (DXF 90, bit 0x10000).
	setOff	Turns off this Viewport object (DXF 90, bit 0x20000, DXF 68 zero).
	setOn	Turns on this Viewport object (DXF 90, bit 0x20000, DXF 68 non-zero).
	setOpaque	Not implemented. The set value is not saved to file.
	setPerspectiveOff	Sets perspective off for this Viewport object (DXF 90, bit 0x01).
	setPerspectiveOn	Sets perspective on for this Viewport object (DXF 90, bit 0x01).
	setPlotStyleSheet	Sets the plot style sheet name associated with this Viewport object.
	setRenderMode	Set the render mode of this Viewport object (DXF 281).
	setShadePlot	This is the overview for the setShadePlot method overload.
	setSheetView	Associates a sheet view with this viewport.
	setSnapAngle	Sets the UCS snap angle of this Viewport object (DXF 50).
	setSnapBasePoint	Sets the UCS snap base point of this Viewport object (DXF 13).
	setSnapIncrement	Sets the snap increment of this Viewport object (DXF 14).
	setSnapIsometric	Sets the isometric snap style on for this Viewport object (DXF 90, bit 0x400).
	setSnapIsoPair	Sets the snap IsoPair of this Viewport object (DXF 14).
	setSnapOff	Sets the snap mode off for this Viewport object (DXF 90, bit 0x100).
	setSnapOn	Sets the snap mode on for this Viewport object (DXF 90, bit 0x100).
	setSnapStandard	Sets the isometric snap style off for this Viewport object (DXF 90, bit 0x400).
	setStandardScale	Sets the standard scale type of this Viewport object.
	setSun	Sets the sun (distant light) for this viewport.
	setToneOperatorParameters	Sets the tone parameters for this viewport.
	setTransparent	Not implemented. The set value is not saved to file.
	setTwistAngle	Sets the DCS twist angle of this Viewport object (DXF 51).
	setUcs	This is the overview for the setUcs method overload.
	setUcsFollowModeOff	Sets UCS follow mode off for this Viewport object (DXF 90, bit 0x08).
	setUcsFollowModeOn	Sets UCS follow mode on for this Viewport object (DXF 90, bit 0x08).
	setUcsIconAtCorner	Sets the UCS icon to the corner of this Viewport object (DXF 90, bit 0x40).
	setUcsIconAtOrigin	Sets the UCS icon to the UCS origin for this Viewport object (DXF 90, bit 0x40).
	setUcsIconInvisible	Sets UCS icon visible false for this Viewport object (DXF 90, bit 0x20).
	setUcsIconVisible	Sets UCS icon visible on for this Viewport object (DXF 90, bit 0x20).
	setUcsPerViewport	Controls the activation of the UCS that is associated with this Viewport object with the activation of this Viewport object.
	setUcsToWorld	Sets the UCS associated with this Viewport object to the WCS.
	setUnlocked	Unlocks the scale factor of this Viewport object (DXF 90, bit 0x4000).
	setViewCenter	Sets the DCS view center of this Viewport object (DXF 12).
	setViewDirection	Sets the WCS view direction of this Viewport object (DXF 16).
	setViewHeight	Sets the DCS view height of this Viewport object (DXF 45).
	setViewTarget	Sets the WCS view target of this Viewport object (DXF 17).
	setVisualStyle	Sets the visual style for this viewport.
	setWidth	Sets the width of this Viewport object (DXF 40).
	shadePlot	Retrieves the shade plot mode for this viewport.
	shadePlotId	Retrieves the shade object (visual style or render preset) for the plotting associated with this viewport.
	showHiddenLines	Sets this Viewport object to have hidden shown lines during plotting. (DXF 90, bit 0x800).
	snapAngle	Returns the UCS snap angle of this Viewport object (DXF 50).
	snapBasePoint	Returns the UCS snap base point of this Viewport object (DXF 13).
	snapIncrement	Returns the snap increment of this Viewport object (DXF 14).
	snapIsoPair	Returns the snap IsoPair of this Viewport object (DXF 14).
	standardScale	Returns the standard scale type of this Viewport object
	subClose	Called as the first operation when this object is being closed; for database-resident objects only.
	subErase	Called as the first operation when this object is being erased or unerased.
	subGetClassID	Returns the CLSID value associated with this object.
	subGetGeomExtents	This is subGetGeomExtents, a member of class OdDbViewport.
	subGetTransformedCopy	Retrieves the copied version of this viewport transformed by the specified transformation matrix.
	subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
	subTransformBy	Applies the specified 3D transformation matrix to this entity.
	subWorldDraw	This is subWorldDraw, a member of class OdDbViewport.
	sunId	Retrieves the object identifier of the sun (distant light) associated with this viewport.
	syncModelView	Updates (syncronizes) parameters of the OdDbViewport object with parameters in the associated view.
	thawAllLayersInViewport	Thaws all layers in this Viewport object.
	thawLayersInViewport	Thaws the specified layers in this Viewport object (DXF 341)
	toneOperatorParameters	Retrieves tone parameters for this viewport.
	twistAngle	Returns the DCS twist angle of this Viewport object (DXF 51).
	ucsName	Returns the Object ID of the UCS associated with this Viewport object (DXF 345 or 346).
	updateDisplay	Updates the display to reflect changes in this Viewport object.
	viewCenter	Returns the DCS view center of this Viewport object (DXF 12).
	viewDirection	Returns the WCS view direction of this Viewport object (DXF 16).
	viewHeight	Returns the DCS view height of this Viewport object (DXF 45).
	viewTarget	Returns the WCS view target of this Viewport object (DXF 17).
	visualStyle	Retrieves an identifier of the visual style object that is used for this viewport.
	width	Returns the width of this Viewport object (DXF 40).
	zoomExtents	Adjusts the parameters of this viewport object such that the view is zoomed to the extents of the drawing.

Send feedback about this topic