File3dmDisplacement

References
public class File3dmDisplacement
Represents the displacement attached to file3dm object attributes.

Properties

BlackPoint

#Since v8.0
Specifies the amount of displacement for the black color in the texture.
public double BlackPoint { get; set; }

Fairing

#Since v8.0
Specifies the number of steps for the fairing process. Fairing straightens rough feature edges.
public int Fairing { get; set; }

FairingOn

#Since v8.0
Specifies whether or not to perform a fairing step. Fairing straightens rough feature edges.
public bool FairingOn { get; set; }

FinalMaxFaces

#Since v8.0
Specifies how many faces the reduction post process should target.
public int FinalMaxFaces { get; set; }

FinalMaxFacesOn

#Since v8.0
Specifies whether to perform a mesh reduction as a post process to simplify the result of displacement.
public bool FinalMaxFacesOn { get; set; }

InitialQuality

#Since v8.0
Specifies how densely the object is initially subdivided. The lower the value, the higher the resolution of the displaced mesh.
public int InitialQuality { get; set; }

MappingChannel

#Since v8.0
Specifies which texture mapping channel is used for the displacement texture.
public int MappingChannel { get; set; }

MeshMemoryLimit

#Since v8.0
Specifies in megabytes how much memory can be allocated for use by the displacement mesh.
public int MeshMemoryLimit { get; set; }

On

#Since v8.0
Specifies whether the displacement feature is enabled or not.
public bool On { get; set; }

PostWeldAngle

#Since v8.0
Specifies the maximum angle between face normals of adjacent faces that will get welded together.
public double PostWeldAngle { get; set; }

RefineSensitivity

#Since v8.0
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 double RefineSensitivity { get; set; }

RefineSteps

#Since v8.0
Specifies the number of refinement passes
public int RefineSteps { get; set; }

SweepResolutionFormula

#Since v8.0
Specifies which formula is used to calculate sweep resolution from initial quality.
public File3dmDisplacement.SweepResolutionFormulas SweepResolutionFormula { get; set; }

TextureId

#Since v8.0
Specifies which texture is used for computing the displacement amount.
public Guid TextureId { get; set; }

WhitePoint

#Since v8.0
Specifies the amount of displacement for the white color in the texture.
public double WhitePoint { get; set; }

Methods

AddSubItem

#Since v8.0
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 bool AddSubItem(
face_index,
on,
texture,
mapping_channel,
black_point,
white_point
)

DeleteAllSubItems

#Since v8.0
Deletes all the sub-items from the displacement.
public void DeleteAllSubItems()

DeleteSubItem

#Since v8.0
Deletes a sub-item by its face index. face_index is the index of the face on the polysurface/SubD.
public void DeleteSubItem(
face_index
)

GetSubItemFaceIndexes

#Since v8.0
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 int[] GetSubItemFaceIndexes()

SetSubItemBlackPoint

#Since v8.0
Sets the override for displacement 'black-point'. face_index is the index of the face on the polysurface/SubD.
public void SetSubItemBlackPoint(
face_index,
black_point
)

SetSubItemMappingChannel

#Since v8.0
Sets the override for displacement 'mapping channel'. face_index is the index of the face on the polysurface/SubD.
public void SetSubItemMappingChannel(
face_index,
chan
)

SetSubItemOn

#Since v8.0
Sets the override for displacement 'on'. face_index is the index of the face on the polysurface/SubD.
public void SetSubItemOn(
face_index,
on
)

SetSubItemTexture

#Since v8.0
Sets the override for displacement 'texture'. face_index is the index of the face on the polysurface/SubD.
public void SetSubItemTexture(
face_index,
texture_id
)

SetSubItemWhitePoint

#Since v8.0
Sets the override for displacement 'white-point'. face_index is the index of the face on the polysurface/SubD.
public void SetSubItemWhitePoint(
face_index,
white_point
)

SubItemBlackPoint

#Since v8.0
Gets the override for displacement 'black-point'. face_index is the index of the face on the polysurface/SubD.
public double SubItemBlackPoint(
face_index
)

SubItemMappingChannel

#Since v8.0
Gets the override for displacement 'mapping channel'. face_index is the index of the face on the polysurface/SubD.
public int SubItemMappingChannel(
face_index
)

SubItemOn

#Since v8.0
Gets the override for displacement 'on'. face_index is the index of the face on the polysurface/SubD.
public bool SubItemOn(
face_index
)

SubItemTexture

#Since v8.0
Gets the override for displacement 'texture'. face_index is the index of the face on the polysurface/SubD.
public Guid SubItemTexture(
face_index
)

SubItemWhitePoint

#Since v8.0
Gets the override for displacement 'white-point'. face_index is the index of the face on the polysurface/SubD.
public double SubItemWhitePoint(
face_index
)