DisplayPipelineAttributes

Public Class

Represents display pipeline settings, such as “show transparency” and “show grips”.

Inheritance Hierarchy

System.Object
Rhino.Display.DisplayPipelineAttributes

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public class DisplayPipelineAttributes : IDisposable,
  ISerializable

The DisplayPipelineAttributes type exposes the following members.

Constructors

Name

Description

Protected Method

DisplayPipelineAttributes

Initializes a new instance of the DisplayPipelineAttributes class

Properties

Name

Description

Public Property

AmbientLightingColor

Public Property

AxesSizePercentage

Size of axes as a percentage of the grid extents.

Public Property

BackMaterialDiffuseColor

Public Property

BackMaterialShine

Get or set the back material shine (0 to Rhino.DocObjects.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.

Public Property

BackMaterialTransparency

Get or set the back material transparency (0 to 100). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.

Public Property

BoundingBoxMode

Public Property

CastShadows

Cast shadows.

Public Property

ClippingEdgeColor

Clipping edge color

Public Property

ClippingEdgeColorUsage

Specifies how the color for the Edges is determined

Public Property

ClippingEdgeThickness

Edge thickness in pixels.

Public Property

ClippingFillColor

Clipping plane fill color

Public Property

ClippingPlaneFillColorUsage

Specifies how the color for the clipping plane object fill is determined.

Public Property

ClippingShadeColor

Clipping plane solid color

Public Property

ClippingShadeColorUsage

Specifies how to shade the clipping plane

Public Property

ClippingShadeSelectedPlane

Shades the selected clipping plane.

Public Property

ClippingShadeTransparency

Specifies the clipping plane transparency percentage.

Public Property

ClipSelectionHighlight

Clips the highlight wires. Shaded selections always clip.

Public Property

ContextForDraw

Public Property

ControlPolygonColor

Control polygon color

Public Property

ControlPolygonGripSize

The control point size in pixels.

Public Property

ControlPolygonHighlight

Highlights the segments of the control polygon on either side of the control points.

Public Property

ControlPolygonShow

Shows the control polygon and only shows the control points.

Public Property

ControlPolygonShowPoints

Shows the control points while the control polygon is displayed.

Public Property

ControlPolygonShowSurface

Shows the object while the control polygon is displayed.

Public Property

ControlPolygonStyle

PointStyle for the control polygon. Supported values are ControlPoint, RoundControlPoint, VariableDot, and RoundDot

Public Property

ControlPolygonUseFixedSingleColor

Specifies a color for the control polygon.

Public Property

ControlPolygonUseSolidLines

Use dotted / solid lines

Public Property

ControlPolygonWireThickness

The width of the control polygon lines in pixels.

Public Property

CullBackfaces

Public Property

CurveColor

Color used for drawing curves

Public Property

CurveThickness

Pixel thickness for curves

Public Property

CurveThicknessScale

Scale thickness for curves

Public Property

CurveThicknessUsage

Use a pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)

Public Property

CustomGroundPlaneAltitude

Height above the world XY plane in model units

Public Property

CustomGroundPlaneAutomaticAltitude

Turns on auto-elevation that moves Ground Plane to the lowest point of the objects in the model.

Public Property

CustomGroundPlaneOn

Turn the custom ground plane on or off

Public Property

CustomGroundPlaneShadowOnly

Makes the ground plane transparent, but allows shadows to still be cast on it.

Public Property

DisableConduits

Public Property

DisableTransparency

Public Property

DynamicDisplayUsage

Sets the appearance of objects in the display

Public Property

EnglishName

Public Property

FillMode

Get or set the frame buffer fill mode.

Public Property

FrontMaterialShine

Get or set the front material shine (0 to Rhino.DocObjects.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.

Public Property

FrontMaterialTransparency

Get or set the front material transparency (0 to 100). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.

Public Property

GhostLockedObjects

Set locked appearance

Public Property

GridPlaneColor

The color of the grid plane

Public Property

GridPlaneTransparency

Transparency of the grid plane, percentage (0-100)

Public Property

GridPlaneVisibility

Set when to show the grid plane

Public Property

GridTransparency

Transparency of the grid, percentage (0-100)

Public Property

HighlightSurfaces

Shades entire object with highlight color.

Public Property

IgnoreHighlights

Public Property

LayersFollowLockUsage

Applies the settings for locked objects to locked layers.

Public Property

LightingScheme

Public Property

LocalName

Public Property

LockedColor

Locked Object Color

Public Property

LockedObjectsDrawBehindOthers

Locked object are drawn behind other objects

Public Property

LockedObjectTransparency

LockedObjectTransparency.

Public Property

LockedObjectUsage

Set asource of display attributes for locked objects

Public Property

MeshEdgeColor

Sets the mesh edge color

Public Property

MeshEdgeColorReduction

The darken percentage of the color

Public Property

MeshEdgeThickness

Mesh edge width in pixels

Public Property

MeshNakedEdgeColor

Sets the naked edge color

Public Property

MeshNakedEdgeColorReduction

The darken percentage of the color

Public Property

MeshNakedEdgeThickness

Naked mesh edge width in pixels.}

Public Property

MeshNonmanifoldEdgeColor

Sets the nonmanifold edge color

Public Property

MeshNonmanifoldEdgeColorReduction

The darken percentage of the color

Public Property

MeshNonmanifoldEdgeThickness

Non-manifold mesh edge width in pixels

Public Property

MeshSpecificAttributes

Public Property

MeshVertexSize

Mesh vertex size in pixels

Public Property

ObjectColor

Public Property

PlaneUsesGridColor

If true, use the grid thin line color in App settings

Public Property

PointCloudRadius

Public Property

PointCloudStyle

Public Property

PointRadius

Public Property

PointStyle

Public Property

RealtimeDisplayId

Get the ID of the real-time display engine attached to the view. This will be Guid.Empty if no real-time display engine is in use. This can be the case for instance when starting a _Render session for a real-time viewport integration. That still would cause this ID to be Guid.Empty.

Public Property

RealtimeRenderPasses

Get or set the real-time passes amount

Public Property

ShadeVertexColors

Shade using vertex colors.

Public Property

ShadingEnabled

Draw shaded meshes and surfaces

Public Property

ShadowBiasX

ShadowBiasX (Self shadowing artifacts) from 0 (dirty) to 50 (cleaner).

Public Property

ShadowClippingRadius

Camera-based shadow clipping radius

Public Property

ShadowColor

Public Property

ShadowEdgeBlur

Set blurring from 0 (no blurring) to 16 (maximum blurring)

Public Property

ShadowIntensity

Shadow intensity (percentage 0-100)

Public Property

ShadowMemoryUsage

Value from 1 to 16384 indicating how much memory is to be allocated. Actual memory use is ShadowMemoryUsage*ShadowMemoryUsage*4.

Public Property

ShadowsIgnoreUserDefinedClippingPlanes

If true, shadows ignore user-defined clipping planes

Public Property

ShadowSoftEdgeQuality

Soft edge quality, from 0 (none/faster) to 12 (softer/slower)

Public Property

ShadowsOn

Enable shadows

Public Property

ShadowTransparencyTolerance

Transparency tolerance from 0 (never cast shadows) to 100 (always case shadows)

Public Property

ShowAnnotations

Show annotations.

Public Property

ShowClipIntersectionEdges

Show edges and hatches where clipping planes clip objects

Public Property

ShowClipIntersectionSurfaces

Show fills where clipping planes clip solid objects

Public Property

ShowClippingEdges

Shows the edges between the clipping plane and clipped objects.

Public Property

ShowClippingFills

When a clipping plane intersects a 3-D object and the section is closed, the section is filled.

Public Property

ShowClippingPlanes

Show clipping planes.

Public Property

ShowCurves

Draw curves

Public Property

ShowGrips

Public Property

ShowIsoCurves

Draw surface ISO curves.

Public Property

ShowLights

Show light widgets.

Public Property

ShowMeshEdges

Display mesh edges on/off

Public Property

ShowMeshNakedEdges

Display mesh naked edges on/off

Public Property

ShowMeshNonmanifoldEdges

Display mesh manifold edges on/off

Public Property

ShowPointClouds

Show point clouds.

Public Property

ShowPoints

Show points.

Public Property

ShowRealtimeRenderProgressBar

Get or set whether the display is used for preview rendering or not.

Public Property

ShowSubDBoundary

Set visibility of SubD naked edges.

Public Property

ShowSubDCreases

Set visibility of SubD creased edges.

Public Property

ShowSubDEdges

Set visibility of SubD smooth edges.

Public Property

ShowSubDNonmanifoldEdges

Turn on/off color differentiation of SubD symmetry children.

Public Property

ShowSubDReflectionPlanePreview

Public Property

ShowSurfaceEdge

Turn Surface Edge visibility on or off

Public Property

ShowSurfaceEdges

Show surface edges.

Public Property

ShowSurfaceNakedEdge

Turn Surface Naked Edge visibility on or off

Public Property

ShowTangentEdges

Show tangent edges.

Public Property

ShowTangentSeams

Show tangent seams.

Public Property

ShowText

Show text.

Public Property

SkylightShadowQuality

Skylight shadow quality, from 0 (lowest) to 8 (highest)

Public Property

StereoContext

Get or set the stereo render context.

Public Property

SubDBoundaryApplyPattern

Apply pattern to the edge

Public Property

SubDBoundaryColorReduction

Color reduction percentage

Public Property

SubDBoundaryEdgeColor

Edge color

Public Property

SubDBoundaryEdgeColorUsage

Edge color usage

Public Property

SubDBoundaryEdgeThickness

Edge thickness (pixels).

Public Property

SubDBoundaryThicknessScale

Edge thickness scale

Public Property

SubDBoundaryThicknessUsage

Public Property

SubDCreaseInteriorApplyPattern

Apply pattern to the edge

Public Property

SubDCreaseInteriorColorReduction

Color reduction percentage

Public Property

SubDCreaseInteriorEdgeColor

Edge color

Public Property

SubDCreaseInteriorEdgeColorUsage

Edge color usage

Public Property

SubDCreaseInteriorEdgeThickness

Edge thickness (pixels).

Public Property

SubDCreaseInteriorThicknessScale

Edge thickness scale

Public Property

SubDCreaseInteriorThicknessUsage

Public Property

SubDNonManifoldApplyPattern

Apply pattern to the edge

Public Property

SubDNonManifoldColorReduction

Color reduction percentage

Public Property

SubDNonManifoldEdgeColor

Edge color

Public Property

SubDNonManifoldEdgeColorUsage

Edge color usage

Public Property

SubDNonManifoldEdgeThickness

Edge thickness (pixels).

Public Property

SubDNonManifoldThicknessScale

Edge thickness scale

Public Property

SubDNonManifoldThicknessUsage

Public Property

SubDReflectionAxisLineColor

Reflection axis line color

Public Property

SubDReflectionPlaneAxisLineOn

Apply Turnh on or off the reflection plane axis line

Public Property

SubDReflectionPlaneColor

Reflection plane color

Public Property

SubDReflectionPlaneColorReduction

SubD replection plane color reduction percentage

Public Property

SubDReflectionPlaneColorUsage

SubD replection plane color use

Public Property

SubDSmoothInteriorApplyPattern

Apply pattern to the edge

Public Property

SubDSmoothInteriorColorReduction

Color reduction percentage

Public Property

SubDSmoothInteriorEdgeColor

Edge color

Public Property

SubDSmoothInteriorEdgeColorUsage

Edge color usage

Public Property

SubDSmoothInteriorEdgeThickness

Edge thickness (pixels).

Public Property

SubDSmoothInteriorThicknessScale

Edge thickness scale

Public Property

SubDSmoothInteriorThicknessUsage

Public Property

SubDThicknessUsage

Thickness usage, pixel thickness or a scale thickness

Public Property

SurfaceEdgeApplyPattern

Turn pattern application on or off

Public Property

SurfaceEdgeColor

Public Property

SurfaceEdgeColorReduction

Public Property

SurfaceEdgeColorUsage

Public Property

SurfaceEdgeThickness

Thickness for surface edges

Public Property

SurfaceEdgeThicknessScale

Public Property

SurfaceIsoColorsUsed

Public Property

SurfaceIsoShowForFlatFaces

Public Property

SurfaceIsoSingleColor

Public Property

SurfaceIsoThickness

Public Property

SurfaceIsoThicknessUScale

Public Property

SurfaceIsoThicknessUsed

Public Property

SurfaceIsoThicknessVScale

Public Property

SurfaceIsoThicknessWScale

Public Property

SurfaceIsoUColor

Public Property

SurfaceIsoUThickness

Public Property

SurfaceIsoUVColor

Public Property

SurfaceIsoVColor

Public Property

SurfaceIsoVThickness

Public Property

SurfaceNakedAdgeColorReduction

Public Property

SurfaceNakedEdgeApplyPattern

Turn pattern application on or off

Public Property

SurfaceNakedEdgeColor

Public Property

SurfaceNakedEdgeColorUsage

Public Property

SurfaceNakedEdgeThickness

Public Property

SurfaceNakedEdgeThicknessScale

Public Property

UseAssignedObjectMaterial

Gets or sets whether objects ought to be drawn using their assigned rendering material.

Public Property

UseCustomObjectColor

Gets or sets whether objects ought to be drawn using a custom color.

Public Property

UseCustomObjectColorBackfaces

Gets or sets whether objects ought to be drawn using a custom color for back faces.

Public Property

UseCustomObjectMaterial

Gets or sets whether objects ought to be drawn using a custom material.

Public Property

UseCustomObjectMaterialBackfaces

Gets or sets whether objects ought to be drawn using a custom material on backfaces.

Public Property

UseLightColor

Draw lights using light color

Public Property

UseSectionStyles

When enabled, the appearances of clipping fills and edges are based on objects’ section style properties.

Public Property

UseSingleCurveColor

Use a single color for drawing curves

Public Property

ViewSpecificAttributes

Public Property

WorldAxesIconColorUsage

Public Property

XrayAllObjects

Methods

Name

Description

Public Method

Dispose.

Releases all resources used by the DisplayPipelineAttributes

Protected Method

Dispose(Boolean)

Releases the unmanaged resources used by the DisplayPipelineAttributes and optionally releases the managed resources

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected Method

Finalize

(Overrides Object.Finalize..)

Public Method

GetColorFadeEffect

Get the current color fade effect data.

Public Method

GetDiagonalHatchEffect

Get the current diagonal hatch strength and width in pixels.

Public Method

GetDitherTransparencyEffect

Get the current dither transparency amount.

Public Method

GetFill

Get fill colors used for clearing the frame buffer

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetObjectData

Public Method

GetSurfaceEdgeThicknessUsage

Helper function for setting the SurfaceEdgeThicknessFlags

Public Method

GetSurfaceIsoApplyPattern

Public Method

GetSurfaceIsoColorUsage

Helper function for getting SurfaceIsoColorsUsed and SurfaceSingleIsoColor

Public Method

GetSurfaceIsoThicknessUsage

This is a helper function that combines getting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.

Public Method

GetSurfaceNakedEdgeThicknessUsage

This is a helper function that combines getting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

HasColorFadeEffect

Returns TRUE if there is a color fade effect enabled with a color fade effect amount larger than 0.0, FALSE otherwise.

Public Method

HasDiagonalHatchEffect

Returns TRUE if there is a diagonal hatch effect enabled with a hatch strength larger than 0.0, FALSE otherwise.

Public Method

HasDitherTransparencyEffect

Returns TRUE if there is a dither transparency effect enabled with a transparency amount larger than 0.0, FALSE otherwise.

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Public Method

SetColorFadeEffect

Set a color fade effect to make objects fade a given amount towards a given color.

Public Method

SetDiagonalHatchEffect

Set a diagonal hatch effect to make objects render with diagonal hatch with a given strength and width in pixels. The effect works by brightening and darkening pixels in a diagonal pattern.

Public Method

SetDitherTransparencyEffect

Set a dither transparency effect to make objects render with a given amount of transparency using a dither effect.

Public Method

SetFill(Color)

Set fill mode to solid color and set the fill color

Public Method

SetFill(Color, Color)

Set fill mode to two color and set the colors

Public Method

SetFill(Color, Color, Color, Color)

Set the fill mode to four color gradient and set the colors

Public Method

SetSurfaceEdgeThicknessUsage

Helper function for getting the SurfaceEdgeThicknessFlags

Public Method

SetSurfaceIsoApplyPattern

Public Method

SetSurfaceIsoColorUsage

Helper function for setting SurfaceIsoColorsUsed and SurfaceIsoSingleColor

Public Method

SetSurfaceIsoThicknessUsage

This is a helper function that combines setting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.

Public Method

SetSurfaceNakedEdgeThicknessUsage

This is a helper function that combines setting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)