RhinoCommon documentation has a new look. The old site can still be found here.

/

/

DisplayPipelineAttributes

DisplayPipelineAttributes class

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

Derived Classes:

Namespace: Rhino.Display
DisplayPipelineAttributes: references

Constructors (1)

DisplayPipelineAttributes(SerializationInfo info, StreamingContext context)

Properties (192)

AmbientLightingColor

AxesSizePercentage

Size of axes as a percentage of the grid extents.

BackMaterialDiffuseColor

BackMaterialShine

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

BackMaterialTransparency

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

BoundingBoxMode

CastShadows

ClippingEdgeColor

Clipping edge color

ClippingEdgeColorUsage

Specifies how the color for the Edges is determined

ClippingEdgeThickness

Edge thickness in pixels.

ClippingFillColor

Clipping plane fill color

ClippingPlaneFillColorUsage

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

ClippingShadeColor

Clipping plane solid color

ClippingShadeColorUsage

Specifies how to shade the clipping plane

ClippingShadeSelectedPlane

Shades the selected clipping plane.

ClippingShadeTransparency

Specifies the clipping plane transparency percentage.

ClipSelectionHighlight

Clips the highlight wires. Shaded selections always clip.

ColorReductionPct

ContextForDraw

ControlPolygonColor

Control polygon color

ControlPolygonGripSize

The control point size in pixels.

ControlPolygonHighlight

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

ControlPolygonShow

Shows the control polygon and only shows the control points.

ControlPolygonShowPoints

Shows the control points while the control polygon is displayed.

ControlPolygonShowSurface

Shows the object while the control polygon is displayed.

ControlPolygonStyle

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

ControlPolygonUseFixedSingleColor

Specifies a color for the control polygon.

ControlPolygonUseSolidLines

Use dotted / solid lines

ControlPolygonWireThickness

The width of the control polygon lines in pixels.

CullBackfaces

CurveColor

Color used for drawing curves

CurveThickness

Pixel thickness for curves

CurveThicknessScale

Scale thickness for curves

CurveThicknessUsage

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

CustomGroundPlaneAltitude

Height above the world XY plane in model units

CustomGroundPlaneAutomaticAltitude

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

CustomGroundPlaneOn

Turn the custom ground plane on or off

CustomGroundPlaneShadowOnly

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

DisableConduits

DisableTransparency

DynamicDisplayUsage

Sets the appearance of objects in the display

EnglishName

FillMode

Get or set the frame buffer fill mode.

FrontMaterialShine

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

FrontMaterialTransparency

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

GhostLockedObjects

Set locked appearance

GridPlaneColor

The color of the grid plane

GridPlaneTransparency

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

GridPlaneVisibility

Set when to show the grid plane

GridTransparency

Transparency of the grid, percentage (0-100)

HighlightSurfaces

Shades entire object with highlight color.

Id

IgnoreHighlights

LayersFollowLockUsage

Applies the settings for locked objects to locked layers.

LightingScheme

LocalName

LockedColor

Locked Object Color

LockedObjectsDrawBehindOthers

Locked object are drawn behind other objects

LockedObjectTransparency

LockedObjectTransparency.

LockedObjectUsage

Set asource of display attributes for locked objects

MeshEdgeColor

Sets the mesh edge color

MeshEdgeColorReduction

The darken percentage of the color

MeshEdgeThickness

Mesh edge width in pixels

MeshNakedEdgeColor

Sets the naked edge color

MeshNakedEdgeColorReduction

The darken percentage of the color

MeshNakedEdgeThickness

Naked mesh edge width in pixels.}

MeshNonmanifoldEdgeColor

Sets the nonmanifold edge color

MeshNonmanifoldEdgeColorReduction

The darken percentage of the color

MeshNonmanifoldEdgeThickness

Non-manifold mesh edge width in pixels

MeshSpecificAttributes

MeshVertexSize

Mesh vertex size in pixels

ObjectColor

PlaneUsesGridColor

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

PointCloudRadius

PointCloudStyle

PointRadius

PointStyle

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.

RealtimeRenderPasses

Get or set the real-time passes amount

ShadeVertexColors

Shade using vertex colors.

ShadingEnabled

Draw shaded meshes and surfaces

ShadowBiasX

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

ShadowClippingRadius

Camera-based shadow clipping radius

ShadowColor

ShadowEdgeBlur

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

ShadowIntensity

Shadow intensity (percentage 0-100)

ShadowMemoryUsage

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

ShadowsIgnoreUserDefinedClippingPlanes

If true, shadows ignore user-defined clipping planes

ShadowSoftEdgeQuality

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

ShadowsOn

ShadowTransparencyTolerance

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

ShowAnnotations

Show annotations.

ShowClipIntersectionEdges

Show edges and hatches where clipping planes clip objects

ShowClipIntersectionSurfaces

Show fills where clipping planes clip solid objects

ShowClippingEdges

Shows the edges between the clipping plane and clipped objects.

ShowClippingFills

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

ShowClippingPlanes

Show clipping planes.

ShowCurves

ShowGrips

ShowIsoCurves

Draw surface ISO curves.

ShowLights

Show light widgets.

ShowMeshEdges

Display mesh edges on/off

ShowMeshNakedEdges

Display mesh naked edges on/off

ShowMeshNonmanifoldEdges

Display mesh manifold edges on/off

ShowPointClouds

Show point clouds.

ShowPoints

ShowRealtimeRenderProgressBar

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

ShowSubDBoundary

Set visibility of SubD naked edges.

ShowSubDCreases

Set visibility of SubD creased edges.

ShowSubDEdges

Set visibility of SubD smooth edges.

ShowSubDNonmanifoldEdges

Turn on/off color differentiation of SubD symmetry children.

ShowSubDReflectionPlanePreview

ShowSurfaceEdge

Turn Surface Edge visibility on or off

ShowSurfaceEdges

Show surface edges.

ShowSurfaceNakedEdge

Turn Surface Naked Edge visibility on or off

ShowTangentEdges

Show tangent edges.

ShowTangentSeams

Show tangent seams.

ShowText

SkylightShadowQuality

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

StereoContext

Get or set the stereo render context.

SubDBoundaryApplyPattern

Apply pattern to the edge

SubDBoundaryColorReduction

Color reduction percentage

SubDBoundaryEdgeColor

SubDBoundaryEdgeColorUsage

Edge color usage

SubDBoundaryEdgeThickness

Edge thickness (pixels).

SubDBoundaryThicknessScale

Edge thickness scale

SubDBoundaryThicknessUsage

SubDCreaseInteriorApplyPattern

Apply pattern to the edge

SubDCreaseInteriorColorReduction

Color reduction percentage

SubDCreaseInteriorEdgeColor

SubDCreaseInteriorEdgeColorUsage

Edge color usage

SubDCreaseInteriorEdgeThickness

Edge thickness (pixels).

SubDCreaseInteriorThicknessScale

Edge thickness scale

SubDCreaseInteriorThicknessUsage

SubDNonManifoldApplyPattern

Apply pattern to the edge

SubDNonManifoldColorReduction

Color reduction percentage

SubDNonManifoldEdgeColor

SubDNonManifoldEdgeColorUsage

Edge color usage

SubDNonManifoldEdgeThickness

Edge thickness (pixels).

SubDNonManifoldThicknessScale

Edge thickness scale

SubDNonManifoldThicknessUsage

SubDReflectionAxisLineColor

Reflection axis line color

SubDReflectionPlaneAxisLineOn

Apply Turnh on or off the reflection plane axis line

SubDReflectionPlaneColor

Reflection plane color

SubDReflectionPlaneColorReduction

SubD replection plane color reduction percentage

SubDReflectionPlaneColorUsage

SubD replection plane color use

SubDSmoothInteriorApplyPattern

Apply pattern to the edge

SubDSmoothInteriorColorReduction

Color reduction percentage

SubDSmoothInteriorEdgeColor

SubDSmoothInteriorEdgeColorUsage

Edge color usage

SubDSmoothInteriorEdgeThickness

Edge thickness (pixels).

SubDSmoothInteriorThicknessScale

Edge thickness scale

SubDSmoothInteriorThicknessUsage

SubDThicknessUsage

Thickness usage, pixel thickness or a scale thickness

SurfaceEdgeApplyPattern

Turn pattern application on or off

SurfaceEdgeColor

SurfaceEdgeColorReduction

SurfaceEdgeColorReductionPercent

SurfaceEdgeColorUsage

SurfaceEdgeThickness

Thickness for surface edges

SurfaceEdgeThicknessScale

SurfaceIsoColorsUsed

SurfaceIsoShowForFlatFaces

SurfaceIsoSingleColor

SurfaceIsoThickness

SurfaceIsoThicknessUScale

SurfaceIsoThicknessUsed

SurfaceIsoThicknessVScale

SurfaceIsoThicknessWScale

SurfaceIsoUColor

SurfaceIsoUThickness

SurfaceIsoUVColor

SurfaceIsoVColor

SurfaceIsoVThickness

SurfaceNakedAdgeColorReduction

SurfaceNakedEdgeApplyPattern

Turn pattern application on or off

SurfaceNakedEdgeColor

SurfaceNakedEdgeColorReductionPercent

SurfaceNakedEdgeColorUsage

SurfaceNakedEdgeThickness

SurfaceNakedEdgeThicknessScale

UseAssignedObjectMaterial

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

UseCustomObjectColor

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

UseCustomObjectColorBackfaces

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

UseCustomObjectMaterial

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

UseCustomObjectMaterialBackfaces

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

UseLightColor

Draw lights using light color

UseSectionStyles

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

UseSingleCurveColor

Use a single color for drawing curves

ViewSpecificAttributes

WorldAxesIconColorUsage

XrayAllObjects

Methods (28)

Dispose()

Dispose(bool disposing)

GetColorFadeEffect(out Color fadeColor, out float fadeAmount)

Get the current color fade effect data.

GetCurveThicknessUsage()

Gets current usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)

GetDiagonalHatchEffect(out float hatchStrength, out float hatchWidth)

Get the current diagonal hatch strength and width in pixels.

GetDitherTransparencyEffect()

Get the current dither transparency amount.

GetFill(out Color topLeft, out Color bottomLeft, out Color topRight, out Color bottomRight)

Get fill colors used for clearing the frame buffer

GetObjectData(SerializationInfo info,StreamingContext context)

GetSurfaceEdgeThicknessUsage()

Helper function for setting the SurfaceEdgeThicknessFlags

GetSurfaceIsoApplyPattern(out bool u, out bool v, out bool w)

GetSurfaceIsoColorUsage()

Helper function for getting SurfaceIsoColorsUsed and SurfaceSingleIsoColor

GetSurfaceIsoThicknessUsage()

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

GetSurfaceNakedEdgeThicknessUsage()

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

HasColorFadeEffect()

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

HasDiagonalHatchEffect()

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

HasDitherTransparencyEffect()

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

SetColorFadeEffect(in Color fadeColor, in float fadeAmount)

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

SetCurveThicknessUsage(CurveThicknessUse usage)

Sets usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)

SetDiagonalHatchEffect(in float hatchStrength, in float hatchWidth)

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.

SetDitherTransparencyEffect(in float transparencyAmount)

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

SetFill(Color gradientTop, Color gradientBottom)

Set fill mode to two color and set the colors

SetFill(Color gradientTopLeft, Color gradientBottomLeft, Color gradientTopRight, Color gradientBottomRight)

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

SetFill(Color singleColor)

Set fill mode to solid color and set the fill color

SetSurfaceEdgeThicknessUsage(SurfaceThicknessUse use)

Helper function for getting the SurfaceEdgeThicknessFlags

SetSurfaceIsoApplyPattern(bool u, bool v, bool w)

SetSurfaceIsoColorUsage(SurfaceIsoColorUse use)

Helper function for setting SurfaceIsoColorsUsed and SurfaceIsoSingleColor

SetSurfaceIsoThicknessUsage(SurfaceIsoThicknessUse value)

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

SetSurfaceNakedEdgeThicknessUsage(SurfaceNakedEdgeThicknessUse use)

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

Nothing found