RhinoCommon API
Namespaces
Rhino.DocObjects
RhinoObject Class
RhinoObject Methods
CommitChanges Method
CopyHistoryOnReplace Method
CreateMeshes Method
CreateSections Method
CreateSlices Method
CustomRenderMeshesBoundingBox Method
DeleteHistoryRecord Method
Description Method
DestroyMeshes Method
DuplicateGeometry Method
EnableCustomGrips Method
EnableGrips Method
EnableVisualAnalysisMode Method
FromRuntimeSerialNumber Method
GetActiveVisualAnalysisModes Method
GetBoundingBox Method
GetCustomRenderMeshParameter Method
GetDynamicTransform Method
GetFillSurfaces Method
GetGrips Method
GetGroupList Method
GetHighlightedSubObjects Method
GetMaterial Method
GetMeshes Method
GetRenderMaterial Method
GetRenderMeshes Method
GetRenderMeshesWithUpdatedTCs Method
GetRenderMeshParameters Method
GetRenderPrimitiveList Method
GetSelectedSubObjects Method
GetSubObjects Method
GetTextureChannels Method
GetTextureMapping Method
GetTightBoundingBox Method
HasCustomRenderMeshes Method
HasHistoryRecord Method
HasTextureMapping Method
Highlight Method
HighlightSubObject Method
HistoryChildren Method
HistoryParents Method
InVisualAnalysisMode Method
IsActiveInViewport Method
IsHighlighted Method
IsMeshable Method
IsSelectable Method
IsSelected Method
IsSubObjectHighlighted Method
IsSubObjectSelectable Method
IsSubObjectSelected Method
MemoryEstimate Method
MeshCount Method
MeshObjects Method
ObjectFrame Method
OnAddToDocument Method
OnDeleteFromDocument Method
OnDraw Method
OnDuplicate Method
OnPick Method
OnPicked Method
OnSelectionChanged Method
OnSpaceMorph Method
OnTransform Method
RenderMeshes Method
Select Method
SelectSubObject Method
SetCopyHistoryOnReplace Method
SetCustomRenderMeshParameter Method
SetHistory Method
SetObjectFrame Method
SetRenderMeshParameters Method
SetTextureMapping Method
ShortDescription Method
ShortDescriptionWithClosedStatus Method
SupportsRenderPrimitiveList Method
TryGetGumballFrame Method
TryGetGumballFrameForCurrentAlignment Method
TryGetRenderPrimitiveBoundingBox Method
UnhighlightAllSubObjects Method
UnselectAllSubObjects Method
Click or drag to resize

RhinoObjectRenderMeshes Method

Returns a set of custom render primitives for this object.

Some providers - Displacement in particular - compute their meshes asynchronously. Until that work finishes, this method returns the object's ordinary render mesh instead of the custom one and reports that by setting Incomplete in flags. That mesh is valid geometry but does not yet reflect the provider, so a caller that measures it will see the object as it was beforehand. Test for the flag rather than trusting the first result.

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
Since: 8.0
Syntax
Copy
public RenderMeshes RenderMeshes(
	MeshType mt,
	ViewportInfo vp,
	List<InstanceObject> ancestry,
	ref RenderMeshProviderFlags flags,
	PlugIn plugin,
	DisplayPipelineAttributes attrs
)

Parameters

mt
Type: Rhino.GeometryMeshType
The mesh type requested (render or analysis).
vp
Type: Rhino.DocObjectsViewportInfo
The viewport being rendered
ancestry
Type: System.Collections.GenericListInstanceObject
The ancestry tree - only used for by-parent object properties assignments.
flags
Type: Rhino.Render.CustomRenderMeshesRenderMeshProviderFlags
On input, the options to apply; on return, the same value with any status flags added. Reset it before each call rather than passing the returned value back in. To wait for an asynchronous provider, call again while Incomplete remains set, calling Wait in between: the provider needs the main thread's message queue pumped before it can publish its result, so a retry loop that does not pump will never see the flag clear.
plugin
Type: Rhino.PlugInsPlugIn
The requesting plug-in (typically the calling plugin)
attrs
Type: Rhino.DisplayDisplayPipelineAttributes
Display attributes for the caller - null if this is a full rendering.

Return Value

Type: RenderMeshes
A set of custom render primitives for this object, or the object's ordinary render mesh if an asynchronous provider has not finished - see flags. Null if the object is not in a document.
See Also