ACadSharp.Entities.Viewport

class · ACadSharp · CLR name: ACadSharp.Entities.Viewport

Represents a ACadSharp.Entities.Viewport entity.

Object name F:ACadSharp.DxfFileToken.EntityViewport Dxf class name F:ACadSharp.DxfSubclassMarker.Viewport

Base type: ACadSharp.Entities.Entity. Inherited members are documented on their declaring type.

Interfaces: ACadSharp.Entities.IEntity, ACadSharp.Entities.IGeometricEntity, ACadSharp.IHandledCadObject.

import acadsharp
Type = acadsharp.get_type('ACadSharp.Entities.Viewport')

Declared public members

Signatures retain CLR types and names. Python.NET resolves overloads and converts compatible Python values at call time. Property setters are shown only when public. Operators retain their CLR names; Python.NET also maps supported operators to Python syntax.

.ctor

ACadSharp.Entities.Viewport()

ASDK_XREC_ANNOTATION_SCALE_INFO

static System.String ASDK_XREC_ANNOTATION_SCALE_INFO = ASDK_XREC_ANNOTATION_SCALE_INFO

PaperViewId

static System.Int32 PaperViewId = 1

Paper view Id, it indicates that the viewport acts as a paper size.

ApplyTransform

System.Void ApplyTransform(CSMath.Transform transform)

Documentation inherited from: base member.

Clone

ACadSharp.CadObject Clone()

Documentation inherited from: base member.

GetBoundingBox

CSMath.BoundingBox GetBoundingBox()

Documentation inherited from: base member.

GetModelBoundingBox

CSMath.BoundingBox GetModelBoundingBox()

Gets the bounding box of this viewport in the model space.

SelectEntities

System.Collections.Generic.List[ACadSharp.Entities.Entity] SelectEntities(System.Boolean includePartial = True)

Gets all the entities from the model that are in the view of the viewport.

ActiveStatus

System.Int16 ActiveStatus { get; set; }

Gets or sets the active status code.

Remarks: -1 = On, but is fully off screen, or is one of the viewports that is not active because the $MAXACTVP count is currently being exceeded. 0 = Off 'positive value' = On and active.The value indicates the order of stacking for the viewports, where 1 is the active viewport, 2 is the next, and so forth

AmbientLightColor

ACadSharp.Color AmbientLightColor { get; set; }

Ambient light color.Write only if not black color.

BackClipPlane

System.Double BackClipPlane { get; set; }

Back clip plane Z value.

Boundary

ACadSharp.Entities.Entity Boundary { get; set; }

Hard-pointer ID/handle to entity that serves as the viewport's clipping boundary (only present if viewport is non-rectangular)

Brightness

System.Double Brightness { get; set; }

View brightness

Center

CSMath.XYZ Center { get; set; }

Center point(in WCS).

CircleZoomPercent

System.Int16 CircleZoomPercent { get; set; }

Circle zoom percent

Contrast

System.Double Contrast { get; set; }

View contrast

DefaultLightingType

ACadSharp.Entities.LightingType DefaultLightingType { get; set; }

Default lighting type.

Remarks: 0 = One distant light 1 = Two distant lights

DisplayUcsIcon

System.Boolean DisplayUcsIcon { get; set; }

Display UCS icon at UCS origin flag

Remarks: Controls whether UCS icon represents viewport UCS or current UCS(these will be different if UCSVP is 1 and viewport is not active). However, this field is currently being ignored and the icon always represents the viewport UCS

Elevation

System.Double Elevation { get; set; }

Viewport elevation

FrontClipPlane

System.Double FrontClipPlane { get; set; }

Front clip plane Z value.

FrozenLayers

System.Collections.Generic.List[ACadSharp.Tables.Layer] FrozenLayers { get; }

Frozen layer object ID/handle(multiple entries may exist)

GridSpacing

CSMath.XY GridSpacing { get; set; }

Grid spacing

Height

System.Double Height { get; set; }

Height in paper space units.

Id

System.Int16 Id { get; }

Viewport ID.

Remarks: The first value for a PaperSpace will represent the paper image in the screen.

LensLength

System.Double LensLength { get; set; }

Perspective lens length

MajorGridLineFrequency

System.Int16 MajorGridLineFrequency { get; set; }

Frequency of major grid lines compared to minor grid lines

ObjectName

System.String ObjectName { get; }

Documentation inherited from: base member.

ObjectType

ACadSharp.ObjectType ObjectType { get; }

Documentation inherited from: base member.

RenderMode

ACadSharp.RenderMode RenderMode { get; set; }

Render mode

RepresentsPaper

System.Boolean RepresentsPaper { get; }

Flag that set for those viewports that represent the paper in the view.

Remarks: A paper viewport is only for boundaries only, does not visualize anything.

Scale

ACadSharp.Objects.Scale Scale { get; set; }

Scale assigned for this viewport.

ScaleFactor

System.Double ScaleFactor { get; }

Scale factor applied in this viewport.

Remarks: Represents the scale applied to all the entities in the model when are visualized in the paper.

ShadePlotMode

ACadSharp.Objects.ShadePlotMode ShadePlotMode { get; set; }

Orthographic type of UCS

SnapAngle

System.Double SnapAngle { get; set; }

Snap angle

SnapBase

CSMath.XY SnapBase { get; set; }

Snap base point

SnapSpacing

CSMath.XY SnapSpacing { get; set; }

Snap spacing

Status

ACadSharp.Entities.ViewportStatusFlags Status { get; set; }

Viewport status.

StyleSheetName

System.String StyleSheetName { get; set; }

Plot style sheet name assigned to this viewport

SubclassMarker

System.String SubclassMarker { get; }

Documentation inherited from: base member.

TwistAngle

System.Double TwistAngle { get; set; }

View twist angle

UcsOrigin

CSMath.XYZ UcsOrigin { get; set; }

UCS origin

UcsOrthographicType

ACadSharp.OrthographicType UcsOrthographicType { get; set; }

Orthographic type of UCS

UcsPerViewport

System.Boolean UcsPerViewport { get; set; }

UCS per viewport flag

Remarks: 0 = The UCS will not change when this viewport becomes active. 1 = This viewport stores its own UCS which will become the current UCS whenever the viewport is activated

UcsXAxis

CSMath.XYZ UcsXAxis { get; set; }

UCS X-axis

UcsYAxis

CSMath.XYZ UcsYAxis { get; set; }

UCS Y-axis

UseDefaultLighting

System.Boolean UseDefaultLighting { get; set; }

Default lighting flag.On when no user lights are specified.

ViewCenter

CSMath.XY ViewCenter { get; set; }

View center point(in DCS).

ViewDirection

CSMath.XYZ ViewDirection { get; set; }

View direction vector(in WCS)

ViewHeight

System.Double ViewHeight { get; set; }

View height(in model space units).

ViewTarget

CSMath.XYZ ViewTarget { get; set; }

View target point(in WCS)

ViewWidth

System.Double ViewWidth { get; }

View width (in model space units).

VisualStyle

ACadSharp.Objects.VisualStyle VisualStyle { get; set; }

Visual style

Width

System.Double Width { get; set; }

Width in paper space units.