DisplayPipelineAttributes
ReferencesRepresents display pipeline settings, such as "show transparency" and "show grips".
Constructors
DisplayPipelineAttributes
#Parameters:
| info (SerializationInfo) | |
| context (StreamingContext) |
Finalizer
~DisplayPipelineAttributes
#~DisplayPipelineAttributes()
Properties
Size of axes as a percentage of the grid extents.
Changes the display of the backfaces (the side opposite of the surface normal direction).
The material used to shade the back faces of an object.
Get or set the back material shine (0 to Rhino.DocObjects.Material.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.
Get or set the back material transparency (0.0 opaque to 1.0 transparent). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.
Objects acquire reflectivity from render materials.
Objects acquire transparency from render materials.
Adds the ability to display procedural textures in viewports. When it is turned off, procedural textures in viewports look different from the rendering.
Specifies how the color for the Edges is determined
Edge thickness in pixels.
public DisplayPipelineAttributes.ClippingPlaneFillColorUse ClippingPlaneFillColorUsage { get; set; }
Specifies how the color for the clipping plane object fill is determined.
Clipping plane solid color
Specifies how to shade the clipping plane
Shades the selected clipping plane.
Specifies the clipping plane transparency percentage.
Clips the highlight wires. Shaded selections always clip.
The control point size in pixels.
Highlights the segments of the control polygon on either side of the control points.
Shows the control polygon and only shows the control points.
Shows the control points while the control polygon is displayed.
Shows the object while the control polygon is displayed.
PointStyle for the control polygon. Supported values are ControlPoint, RoundControlPoint, VariableDot, and RoundDot
Specifies a color for the control polygon.
Value: true = Use a specified color for all control polygons.
false = Use the color specified in the object's Properties.
false = Use the color specified in the object's Properties.
Use dotted / solid lines
The width of the control polygon lines in pixels.
Scale thickness for curves
Use a pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)
Height above the world XY plane in model units
Turns on auto-elevation that moves Ground Plane to the lowest point of the objects in the model.
Turn the custom ground plane on or off
Makes the ground plane transparent, but allows shadows to still be cast on it.
Sets the appearance of objects in the display
Get or set the frame buffer fill mode.
Shades the current viewport with no smoothing so the individual render mesh faces are visible.
Shades the current viewport with no smoothing so the individual render mesh faces are visible.
The material used to shade the front faces of an object. The Front* properties on this class are shortcuts into it.
Get or set the front material shine (0 to Rhino.DocObjects.Material.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.
Get or set the front material transparency (0.0 opaque to 1.0 transparent). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.
Objects acquire reflectivity from render materials.
Objects acquire transparency from render materials.
Set locked appearance
Value: true = Locked objects appear transparent
false = Locked objects appear solid
false = Locked objects appear solid
Transparency of the grid plane, percentage (0-100)
Set when to show the grid plane
Transparency of the grid, percentage (0-100)
Turn on or off custom Ground plane settungs
Shades entire object with highlight color.
Draw order support for this display mode. When true (the default), objects with a non-zero draw order are drawn in front of or behind other objects based on that draw order. When false, this display mode ignores per object draw order and draws everything in the standard order.
Applies the settings for locked objects to locked layers.
Turn on or off custom linear workflow settings
Locked object are drawn behind other objects
LockedObjectTransparency.
Set asource of display attributes for locked objects
The darken percentage of the color
Sets the naked edge color
The darken percentage of the color
Naked mesh edge width in pixels.}
Sets the nonmanifold edge color
The darken percentage of the color
Non-manifold mesh edge width in pixels
If true, use the grid thin line color in App settings
Linear workflow Adjust output image
Linear workflow Output image gamma
Linear workflow input textures
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.
Get or set the real-time passes amount
ShadowBiasX (Self shadowing artifacts) from 0 (dirty) to 50 (cleaner).
Camera-based shadow clipping radius
Set blurring from 0 (no blurring) to 16 (maximum blurring)
Shadow intensity (percentage 0-100)
Value from 1 to 16384 indicating how much memory is to be allocated. Actual memory use is ShadowMemoryUsage*ShadowMemoryUsage*4.
If true, shadows ignore user-defined clipping planes
Soft edge quality, from 0 (none/faster) to 12 (softer/slower)
Transparency tolerance from 0 (never cast shadows) to 100 (always case shadows)
Show edges and hatches where clipping planes clip objects
Show fills where clipping planes clip solid objects
Shows the edges between the clipping plane and clipped objects.
When a clipping plane intersects a 3-D object and the section is closed, the section is filled.
Display mesh naked edges on/off
Display mesh manifold edges on/off
Get or set whether the display is used for preview rendering or not.
Set visibility of SubD naked edges.
Set visibility of SubD creased edges.
Set visibility of SubD smooth edges.
Turn on/off color differentiation of SubD symmetry children.
Turn Surface Edge visibility on or off
Turn Surface Naked Edge visibility on or off
Skylight shadow quality, from 0 (lowest) to 8 (highest)
Get or set the stereo render context.
Apply pattern to the edge
Color reduction percentage
Edge color usage
Edge thickness (pixels).
Edge thickness scale
Apply pattern to the edge
Color reduction percentage
Edge color
Edge color usage
Edge thickness (pixels).
Edge thickness scale
Apply pattern to the edge
Color reduction percentage
Edge color usage
Edge thickness (pixels).
Edge thickness scale
Reflection axis line color
Apply Turnh on or off the reflection plane axis line
Reflection plane color
SubD replection plane color reduction percentage
public DisplayPipelineAttributes.SubDReflectionPlaneColorUse SubDReflectionPlaneColorUsage { get; set; }
SubD replection plane color use
Apply pattern to the edge
Color reduction percentage
Edge color
Edge color usage
Edge thickness (pixels).
Edge thickness scale
Thickness usage, pixel thickness or a scale thickness
Turn pattern application on or off
[EditorBrowsable(EditorBrowsableState.Never)]
public int SurfaceEdgeColorReductionPercent { get; set; }
Thickness for surface edges
Turn pattern application on or off
[EditorBrowsable(EditorBrowsableState.Never)]
public int SurfaceNakedEdgeColorReductionPercent { get; set; }
Gets or sets whether objects ought to be drawn using their assigned rendering material.
Use the backface material for displaying backfaces.
Use a custom material for displaying backfaces.
Gets or sets whether objects ought to be drawn using a custom color.
Gets or sets whether objects ought to be drawn using a custom color for back faces.
Gets or sets whether objects ought to be drawn using a custom material.
Gets or sets whether objects ought to be drawn using a custom material on backfaces.
Use the backface material of the object for displaying its backfaces.
When enabled, the appearances of clipping fills and edges are based on objects' section style properties.
Use a single color for drawing curves
Style used to draw control points whose weight is not 1. Defaults to RoundControlPoint, matching the default control point style, so weighted control points are not called out until this is changed.
Methods
public void Dispose()
Get the current color fade effect data.
[EditorBrowsable(EditorBrowsableState.Never)]
public DisplayPipelineAttributes.CurveThicknessUse GetCurveThicknessUsage()
Gets current usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)
Get the current diagonal hatch strength and width in pixels.
Get the current dither transparency amount.
public void GetFill(out Color topLeft, out Color bottomLeft, out Color topRight, out Color bottomRight)
Get fill colors used for clearing the frame buffer
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters:
| info (SerializationInfo) | |
| context (StreamingContext) |
Helper function for setting the SurfaceEdgeThicknessFlags
Helper function for getting SurfaceIsoColorsUsed and SurfaceSingleIsoColor
This is a helper function that combines getting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.
This is a helper function that combines getting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.
Returns TRUE if there is a color fade effect enabled with a color fade effect amount larger than 0.0, FALSE otherwise.
Returns TRUE if there is a diagonal hatch effect enabled with a hatch strength larger than 0.0, FALSE otherwise.
Returns TRUE if there is a dither transparency effect enabled with a transparency amount larger than 0.0, FALSE otherwise.
Set a color fade effect to make objects fade a given amount towards a given color.
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetCurveThicknessUsage(CurveThicknessUse usage)
Sets usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)
Parameters:
| usage (DisplayPipelineAttributes.CurveThicknessUse) |
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.
Set a dither transparency effect to make objects render with a given amount of transparency using a dither effect.
Parameters:
| transparencyAmount (in float) | The amount of transparency (0..1). |
Set fill mode to two color and set the colors
public void SetFill(Color gradientTopLeft, Color gradientBottomLeft, Color gradientTopRight, Color gradientBottomRight)
Set the fill mode to four color gradient and set the colors
Set fill mode to solid color and set the fill color
Parameters:
| singleColor (Color) |
Helper function for getting the SurfaceEdgeThicknessFlags
Parameters:
| use (DisplayPipelineAttributes.SurfaceThicknessUse) |
Helper function for setting SurfaceIsoColorsUsed and SurfaceIsoSingleColor
Parameters:
| use (DisplayPipelineAttributes.SurfaceIsoColorUse) |
This is a helper function that combines setting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.
Parameters:
| value (DisplayPipelineAttributes.SurfaceIsoThicknessUse) |
This is a helper function that combines setting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.
Parameters:
| use (DisplayPipelineAttributes.SurfaceNakedEdgeThicknessUse) |