File3dmDisplacement

Public Class

Represents the displacement attached to file3dm object attributes.

Inheritance Hierarchy

System.Object
Rhino.FileIO.File3dmDisplacement

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class File3dmDisplacement

The File3dmDisplacement type exposes the following members.

Properties

Name

Description

---

Public Property

BlackPoint

Specifies the amount of displacement for the black color in the texture.

---

Public Property

Fairing

Specifies the number of steps for the fairing process. Fairing straightens rough feature edges.

---

Public Property

FairingOn

Specifies whether or not to perform a fairing step. Fairing straightens rough feature edges.

---

Public Property

FinalMaxFaces

Specifies how many faces the reduction post process should target.

---

Public Property

FinalMaxFacesOn

Specifies whether to perform a mesh reduction as a post process to simplify the result of displacement.

---

Public Property

InitialQuality

Specifies how densely the object is initially subdivided. The lower the value, the higher the resolution of the displaced mesh.

---

Public Property

MappingChannel

Specifies which texture mapping channel is used for the displacement texture.

---

Public Property

MeshMemoryLimit

Specifies in megabytes how much memory can be allocated for use by the displacement mesh.

---

Public Property

On

Specifies whether the displacement feature is enabled or not.

---

Public Property

PostWeldAngle

Specifies the maximum angle between face normals of adjacent faces that will get welded together.

---

Public Property

RefineSensitivity

Specifies how sensitive the divider for contrasts is on the displacement texture. Specify 1 to split all mesh edges on each refine step. Specify 0.99 to make even slight contrasts on the displacement texture cause edges to be split. Specifying 0.01 only splits edges where heavy contrast exists.

---

Public Property

RefineSteps

Specifies the number of refinement passes

---

Public Property

SweepResolutionFormula

Specifies which formula is used to calculate sweep resolution from initial quality.

---

Public Property

TextureId

Specifies which texture is used for computing the displacement amount.

---

Public Property

WhitePoint

Specifies the amount of displacement for the white color in the texture.

---

Methods

Name

Description

---

Public Method

AddSubItem

Adds a new sub-item to the displacement. face_index is the index of the face on the polysurface/SubD.on is the override for File3dmDisplacement.On.texture is the override for File3dmDisplacement.TextureId.mapping_channel is the override for File3dmDisplacement.MappingChannel.black_point is the override for File3dmDisplacement.BlackPoint.white_point is the override for File3dmDisplacement.WhitePoint.

---

Public Method

DeleteAllSubItems

Deletes all the sub-items from the displacement.

---

Public Method

DeleteSubItem

Deletes a sub-item by its face index. face_index is the index of the face on the polysurface/SubD.

---

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

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetSubItemFaceIndexes

Gets all the sub-items on the displacement. Sub-items can exist to override the top-level parameters for polysurface/SubD faces. Sub-items are identified by the face index that they apply to. An array of the face indexes of each sub-item on the displacement.

---

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

SetSubItemBlackPoint

Sets the override for displacement ‘black-point’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SetSubItemMappingChannel

Sets the override for displacement ‘mapping channel’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SetSubItemOn

Sets the override for displacement ‘on’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SetSubItemTexture

Sets the override for displacement ‘texture’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SetSubItemWhitePoint

Sets the override for displacement ‘white-point’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SubItemBlackPoint

Gets the override for displacement ‘black-point’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SubItemMappingChannel

Gets the override for displacement ‘mapping channel’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SubItemOn

Gets the override for displacement ‘on’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SubItemTexture

Gets the override for displacement ‘texture’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

SubItemWhitePoint

Gets the override for displacement ‘white-point’. face_index is the index of the face on the polysurface/SubD.

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---