CustomRenderMeshProvider

References
public abstract class CustomRenderMeshProvider
You must call CustomRenderMeshProvider.RegisterProviders() from your plug-ins OnLoad override for each assembly containing a custom mesh provider. Only publicly exported classes derived from CustomRenderMeshProvider with a public constructor that has no parameters will get registered.

Constructors

CustomRenderMeshProvider

#Obsolete v6.0
protected CustomRenderMeshProvider()
Default constructor

Properties

CurvePipingId

#Since v6.0 Obsolete v6.0
public static Guid CurvePipingId { get; }

DisplacementId

#Since v6.0 Obsolete v6.0
public static Guid DisplacementId { get; }

EdgeSofteningId

#Since v6.0 Obsolete v6.0
public static Guid EdgeSofteningId { get; }

Name

#Since v5.7 Obsolete v6.0
public abstract string Name { get; }
The name of the provider for UI display.

ShutLiningId

#Since v6.0 Obsolete v6.0
public static Guid ShutLiningId { get; }

ThickeningId

#Since v6.0 Obsolete v6.0
public static Guid ThickeningId { get; }

Methods

AllObjectsChanged

#Since v5.7 Obsolete v6.0
public static void AllObjectsChanged()
obsoleteUse version that requires a document
Call this method if your render meshes change.

AllObjectsChanged

#Since v6.0 Obsolete v6.0
public static void AllObjectsChanged(RhinoDoc doc)
Call this method if your render meshes change.
Parameters:
doc (RhinoDoc)

BoundingBox

#Since v5.7 Obsolete v6.0
public virtual BoundingBox BoundingBox(ViewportInfo vp, RhinoObject obj, Guid requestingPlugIn, bool preview)
Returns a bounding box for the custom render meshes for the given object.
Parameters:
vp (ViewportInfo)The viewport being rendered.
obj (RhinoObject)The Rhino object of interest. This can be null in the case where document meshes (not associated with any object) are being requested.
requestingPlugIn (Guid)UUID of the RDK plug-in requesting the meshes.
preview (bool)Type of mesh to build.
Returns: A bounding box value.

BoundingBox

#Since v6.0 Obsolete v6.0
public BoundingBox BoundingBox(ViewportInfo vp, RhinoObject obj, RhinoDoc doc, Guid requestingPlugIn, DisplayPipelineAttributes attrs)
Parameters:
vp (ViewportInfo)
obj (RhinoObject)
doc (RhinoDoc)
requestingPlugIn (Guid)
attrs (DisplayPipelineAttributes)

BuildCustomMeshes

#Since v5.7 Obsolete v6.0
public abstract bool BuildCustomMeshes(ViewportInfo vp, RenderPrimitiveList objMeshes, Guid requestingPlugIn, bool meshType)
Build custom render mesh(es).
Parameters:
vp (ViewportInfo)The viewport being rendered.
objMeshes (RenderPrimitiveList)The meshes class to populate with custom meshes.
requestingPlugIn (Guid)UUID of the RDK plug-in requesting the meshes.
meshType (bool)Type of mesh to build.
Returns: true if operation was successful.

DocumentBasedMeshesChanged

#Since v6.0 Obsolete v6.0
public static void DocumentBasedMeshesChanged(RhinoDoc doc)
Parameters:
doc (RhinoDoc)

ObjectChanged

#Since v6.0 Obsolete v6.0
public static void ObjectChanged(RhinoDoc doc, RhinoObject obj)
Parameters:
doc (RhinoDoc)
obj (RhinoObject)

RegisterProviders

#Since v5.7 Obsolete v6.0
public static void RegisterProviders(Assembly assembly, Guid pluginId)
Call this method once from your plug-ins OnLoad override for each assembly containing a custom mesh provider. Only publicly exported classes derived from CustomRenderMeshProvider with a public constructor that has no parameters will get registered.
Parameters:
assembly (Assembly)Assembly to search for valid CustomRenderMeshProvider derived classes.
pluginId (Guid)The plug-in that owns the custom mesh providers.

WillBuildCustomMeshes

#Since v5.7 Obsolete v6.0
public abstract bool WillBuildCustomMeshes(ViewportInfo vp, RhinoObject obj, Guid requestingPlugIn, bool preview)
Determines if custom render meshes will be built for a particular object.
Parameters:
vp (ViewportInfo)The viewport being rendered.
obj (RhinoObject)The Rhino object of interest. This can be null in the case where document meshes (not associated with any object) are being requested.
requestingPlugIn (Guid)UUID of the RDK plug-in requesting the meshes.
preview (bool)Type of mesh to build.
Returns: true if custom meshes will be built.