File3dmDisplacement

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

Properties

BlackPoint

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

Fairing

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

FairingOn

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

FinalMaxFaces

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

FinalMaxFacesOn

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

InitialQuality

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

MappingChannel

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

MeshMemoryLimit

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

On

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

PostWeldAngle

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

RefineSensitivity

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

RefineSteps

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

SweepResolutionFormula

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

TextureId

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

WhitePoint

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

Methods

AddSubItem

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

DeleteAllSubItems

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

DeleteSubItem

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

GetSubItemFaceIndexes

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

SetSubItemBlackPoint

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

SetSubItemMappingChannel

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

SetSubItemOn

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

SetSubItemTexture

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

SetSubItemWhitePoint

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

SubItemBlackPoint

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

SubItemMappingChannel

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

SubItemOn

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

SubItemTexture

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

SubItemWhitePoint

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