ModelInstanceDefinition

ModelComponentContentModelContentModelDataReferences
[TypeName("Model Block Definition")] [TypeDescription("Rhino model block definition")] public sealed class ModelInstanceDefinition : ModelComponentContent, IGH_BakeAwareData, IGH_PreviewData, IGH_PreviewMeshData
Represents a Rhino block definition. Wraps the functionality of the InstanceDefinition type.

Constructors

ModelInstanceDefinition

#
public ModelInstanceDefinition()

ModelInstanceDefinition

#
public ModelInstanceDefinition(Attributes attributes)
Parameters:
attributes (ModelInstanceDefinition.Attributes)

ModelInstanceDefinition

#
public ModelInstanceDefinition(Guid id)
Parameters:
id (Guid)

ModelInstanceDefinition

#
public ModelInstanceDefinition(InstanceDefinition block)
Parameters:
block (InstanceDefinition)

Fields

Serial

protected internal int Serial
inherited fromModelData

Properties

Attribs

#
protected ModelInstanceDefinition.Attributes Attribs { get; set; }

BoundingBox

#
[Browsable(false)] public BoundingBox BoundingBox { get; }
Explicit

IGH_PreviewData.ClippingBox

#
BoundingBox ClippingBox
Implements: ClippingBox

DefaultAttributes

#
protected override ModelData.Attributes DefaultAttributes { get; }
Overrides: ModelData.DefaultAttributes

DisplayName

[Browsable(false)] public string DisplayName { get; }
inherited fromModelData
Implements: DisplayName

FilePath

#
public string FilePath { get; }

Id

public Guid? Id { get; }
inherited fromModelContent

IsReferencedData

protected bool IsReferencedData { get; }
inherited fromModelContent
Implements: IsReferencedData

IsReferencedDataLoaded

protected bool IsReferencedDataLoaded { get; }
inherited fromModelContent
Implements: IsReferencedDataLoaded

IsValid

#
public override bool IsValid { get; }
Overrides: ModelContent.IsValid

IsValidWhyNot

#
protected override string IsValidWhyNot { get; }
Overrides: ModelContent.IsValidWhyNot

Name

public virtual ModelContentName Name { get; }
inherited fromModelContent

Notes

public string Notes { get; }
inherited fromModelContent

Objects

#
public IReadOnlyList<ModelObject> Objects { get; }

Parent

public ModelContentName Parent { get; }
inherited fromModelContent

Tags

public ModelTags Tags { get; }
inherited fromModelContent

TypeDescription

protected string TypeDescription { get; }
inherited fromModelData
Implements: TypeDescription

TypeName

[Browsable(false)] public virtual string TypeName { get; }
inherited fromModelData
Implements: TypeName

Unset

#
public static ModelInstanceDefinition Unset { get; }

UpdateType

#
public InstanceDefinitionUpdateType? UpdateType { get; }

Url

#
public string Url { get; }

UrlDescription

#
public string UrlDescription { get; }

UserText

public ModelUserText UserText { get; }
inherited fromModelComponentContent

Methods

AsFrozen

public ModelContent AsFrozen(bool deep = true)
Try to obtain a dereferenced snapshot of itself.
inherited fromModelContent
Parameters:
deep (bool = true)Determines whether or not referenced content should also be frozen.
Returns: Itself if it is already dereferenced.

BakeGeometry

#
public bool BakeGeometry(RhinoDoc doc, ObjectAttributes att, ref Guid obj_guid)
Parameters:
doc (RhinoDoc)
att (ObjectAttributes)
obj_guid (ref Guid)
Implements: BakeGeometry

Cast

#
public static ModelInstanceDefinition Cast(object source)
Parameters:
source (object)

CastTo<T>

#
public override bool CastTo<T>(ref T target)
Parameters:
target (ref T)
Overrides: ModelContent.CastTo
Explicit

IGH_PreviewMeshData.DestroyPreviewMeshes

#
void DestroyPreviewMeshes()
Implements: DestroyPreviewMeshes
Explicit

IGH_PreviewData.DrawViewportMeshes

#
void DrawViewportMeshes(GH_PreviewMeshArgs args)
Parameters:
args (GH_PreviewMeshArgs)
Implements: DrawViewportMeshes
Explicit

IGH_PreviewData.DrawViewportWires

#
void DrawViewportWires(GH_PreviewWireArgs args)
Parameters:
args (GH_PreviewWireArgs)
Implements: DrawViewportWires

Equals

public bool Equals(ModelContent other)
inherited fromModelContent
Parameters:
other (ModelContent)

Equals

public bool Equals(ModelData other)
inherited fromModelData
Parameters:
other (ModelData)

Equals

public override bool Equals(object other)
inherited fromModelContent
Parameters:
other (object)
Overrides: ModelData.Equals

GetBoundingBox

#
public BoundingBox GetBoundingBox(Transform xform)
Parameters:
xform (Transform)

GetHashCode

public override int GetHashCode()
inherited fromModelContent
Overrides: ModelData.GetHashCode
Explicit

IGH_PreviewMeshData.GetPreviewMeshes

#
Mesh[] GetPreviewMeshes()
Implements: GetPreviewMeshes

InternaliseData

protected bool InternaliseData()
inherited fromModelContent

LoadReferencedData

protected virtual bool LoadReferencedData()
inherited fromModelContent
Implements: LoadReferencedData

Read

protected override bool Read(GH_IReader reader)
inherited fromModelContent
Parameters:
reader (GH_IReader)
Overrides: ModelData.Read
Implements: Read

RenderItem

protected virtual bool RenderItem(Graphics graphics, RectangleF area, int alpha)
inherited fromModelContent
Parameters:
graphics (Graphics)
area (RectangleF)
alpha (int)

RuntimeId

protected internal Guid? RuntimeId(RhinoDoc document)
inherited fromModelContent
Parameters:
document (RhinoDoc)

ToAttributes

#
public ModelInstanceDefinition.Attributes ToAttributes()

ToDetails

public string ToDetails()
inherited fromModelData

TooltipString

public override string TooltipString()
inherited fromModelContent
Overrides: ModelData.TooltipString

ToString

public override string ToString()
inherited fromModelContent
Overrides: ModelData.ToString

UnloadReferencedData

protected virtual void UnloadReferencedData()
inherited fromModelContent
Implements: UnloadReferencedData

Write

protected override bool Write(GH_IWriter writer)
inherited fromModelContent
Parameters:
writer (GH_IWriter)
Overrides: ModelData.Write
Implements: Write

Convertors

OperationResultDescription
implicitModelInstanceDefinition.AttributesModelInstanceDefinition
implicitInstanceDefinitionModelInstanceDefinition
implicitstringModelInstanceDefinition