VisualAnalysisMode

Public Class

Represents a base class for visual analysis modes.

This class is abstract.

Inheritance Hierarchy

System.Object
Rhino.Display.VisualAnalysisMode

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class VisualAnalysisMode

The VisualAnalysisMode type exposes the following members.

Constructors

Name

Description

Protected Method

VisualAnalysisMode

Initializes a new instance of the VisualAnalysisMode class

Properties

Name

Description

Public Property

Gets the visual analysis mode GUID. The Guid is specified with the GuidAttribute applied to the class.

Public Property

Name

Gets the name of the analysis mode. It is used by the _What command and the object properties details window to describe the object.

Public Property
Static Member

RhinoCurvatureColorAnalyisModeId

Id for Rhino’s built-in curvature color analysis mode. Surface curvature is shown using false color mapping.

Public Property
Static Member

RhinoCurvatureGraphAnalysisModeId

Id for Rhino’s built-in curvature graphs analysis mode. Curvature hair is shown on curves and surfaces.

Public Property
Static Member

RhinoDraftAngleAnalysisModeId

Id for Rhino’s built-in draft angle analysis mode. Draft angle is displayed using false colors.

Public Property
Static Member

RhinoEdgeAnalysisModeId

Id for Rhino’s built-in edge analysis mode. Brep and mesh edges are shown in a selected color.

Public Property
Static Member

RhinoEdgeContinuityAlalysisModeId

Id for Rhino’s built-in edge continuity analysis mode.

Public Property
Static Member

RhinoEmapAnalysisModeId

Id for Rhino’s built-in emap analysis mode. An environment map is shown on surfaces and meshes.

Public Property
Static Member

RhinoThicknessAnalysisModeId

Id for Rhino’s built-in thickness analysis mode.

Public Property
Static Member

RhinoZebraStripeAnalysisModeId

Id for Rhino’s built-in zebra stripe analysis mode. Zebra stripes are shown on surfaces and meshes.

Public Property

ShowIsoCurves

Gets true if this visual analysis mode will show isocuves on shaded surface objects. Often a mode’s user interface will provide a way to change this setting.

The default is false.

Public Property

Style

Gets the visual analysis mode style.

Methods

Name

Description

Public Method
Static Member

AdjustAnalysisMeshes

Interactively adjusts surface analysis meshes of objects using a Rhino built-in analysis mode.

Protected Method

DrawBrepObject

Draws one brep. Override this method to add your custom behavior.

The default implementation does nothing.

Protected Method

DrawCurveObject

If Style==Wireframe, then the default decomposes the curve object into nurbs curve segments and calls the virtual DrawNurbsCurve for each segment.

Protected Method

DrawMesh

Draws a mesh.

The default implementation does nothing.

Protected Method

DrawMeshObject

Draws one mesh. Override this method to add your custom behavior.

The default implementation does nothing.

Protected Method

DrawNurbsCurve

Draws a NURBS curve. This is a good function to override for analysis modes like curvature hair display.

The default implementation does nothing.

Protected Method

DrawNurbsSurface

Draws a NURBS surface. This is a good function to override to display object-related meshes.

The default implementation does nothing.

Protected Method

DrawPointCloudObject

Draws one point cloud. Override this method to add your custom behavior.

The default implementation does nothing.

Protected Method

DrawPointObject

Draws one point. Override this method to add your custom behavior.

The default implementation does nothing.

Public Method

EnableUserInterface

Turns the analysis mode’s user interface on and off. For Rhino’s built in modes this opens or closes the modeless dialog that controls the analysis mode’s display settings.

Public Method

Equals

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

(Inherited from Object.)

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

Public Method
Static Member

Find(Guid)

Finds a visual analysis mode by guid.

Public Method
Static Member

Find(Type)

Finds a visual analysis mode by type.

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Public Method

ObjectSupportsAnalysisMode

Gets a value indicating if this visual analysis mode can be used on a given Rhino object.

Public Method
Static Member

Registers a custom visual analysis mode for use in Rhino. It is OK to call register multiple times for a single custom analysis mode type, since subsequent register calls will notice that the type has already been registered.

Protected Method
SetUpDisplayAttributes

If an analysis mode needs to modify display attributes, this is the place to do it. In particular, Style==Texture, then this function must be overridden.

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

Protected Method

UpdateVertexColors

If Style==falseColor, then this virtual function must be overridden. Rhino calls this function when it is time for to set the false colors on the analysis mesh vertices. For breps, there is one mesh per face. For mesh objects there is a single mesh.