File3dmDisplacement

File3dmDisplacement class

Represents the displacement attached to file3dm object attributes.

Derived Classes:

Namespace: Rhino.FileIO
File3dmDisplacement: references

Properties (15)

BlackPoint

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

Fairing

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

FairingOn

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

FinalMaxFaces

Specifies how many faces the reduction post process should target.

FinalMaxFacesOn

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

InitialQuality

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

MappingChannel

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

MeshMemoryLimit

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

Specifies whether the displacement feature is enabled or not.

PostWeldAngle

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

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.

RefineSteps

Specifies the number of refinement passes

SweepResolutionFormula

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

TextureId

Specifies which texture is used for computing the displacement amount.

WhitePoint

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

Methods (14)

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.

DeleteAllSubItems()

Deletes all the sub-items from the displacement.

DeleteSubItem(int face_index)

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

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(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.

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.

SetSubItemOn(int face_index, bool on)

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

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.

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.

SubItemBlackPoint(int face_index)

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

SubItemMappingChannel(int face_index)

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

SubItemOn(int face_index)

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

SubItemTexture(int face_index)

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

SubItemWhitePoint(int face_index)

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

Nothing found