Texture

Public Class

Represents a texture that is mapped on objects.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.Texture

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public class Texture : CommonObject

The Texture type exposes the following members.

Constructors

Name

Description

Public Method

Texture.

Initializes a new texture.

Protected Method

Texture(SerializationInfo, StreamingContext)

Protected constructor for internal use.

Properties

Name

Description

Public Property

ApplyUvwTransform

If true then the UVW transform is applied to the texture otherwise the UVW transform is ignored.

Public Property

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

(Inherited from CommonObject.)

Public Property

Enabled

If the texture is enabled then it will be visible in the rendered display otherwise it will not.

Public Property

FileName

Gets or sets a file name that is used by this texture.

NOTE: We are moving away from string-based FileName, and suggest the usage of the new FileReference class.

Also, this filename may well not be a path that makes sense on a user’s computer because it was a path initially set on a different user’s computer. If you want to get a workable path for this user, use the BitmapTable.Find function using this property.

Public Property
FileReference

Gets or sets a copy of the file reference that is used by this texture.

Remarks

After the get or the set method complete, you own the copy you received or passed in, and can Dispose() of it.

Public Property

HasUserData

Gets true if this class has any custom information attached to it through UserData.

(Inherited from CommonObject.)

Public Property

Gets the globally unique identifier of this texture.

Public Property

IsDocumentControlled

If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to “IsReadOnly” will throw a NotSupportedException.

(Inherited from CommonObject.)

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

Public Property

MagFilter

The MagFilter setting controls how the color of the image pixel is calculated when the image pixel corresponds to a fraction of a texture bitmap pixel.

Public Property

MappingChannelId

Public Property

MinFilter

The MinFilter setting controls how the color of the image pixel is calculated when the image pixel corresponds to multiple texture bitmap pixels.

Public Property

Offset

Helper for access to the offset value encoded in UvwTransform

Public Property

ProjectionMode

How texture is projected onto geometry

Public Property

Repeat

Helper for access to the repeat value encoded in UvwTransform

Public Property

Rotation

Helper for access to the rotation value encoded in UvwTransform

Public Property

TextureCombineMode

Determines how this texture is combined with others in a material’s texture list.

Public Property

TextureType

Controls how the pixels in the bitmap are interpreted

Public Property

TreatAsLinear

If false, the texture color values should be correctly by the linear workflow pre-process gamma value (in the document) if linear workflow is on. Otherwise, if the values is true, the values should be used raw from the texture.

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

Public Property

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

(Inherited from CommonObject.)

Public Property

UvwTransform

Transform to be applied to each instance of this texture if ApplyUvw is true

Public Property

WcsBoxProjected

Is true if this texture uses world coordinate system (WCS) box projection for texture mapping. Notice: If this texture is used by an object that has an object coordinate system (OCS) frame defined on a mapping channel then that OCS frame is used instead of the WCS.

Public Property

WcsProjected

Is true if this texture uses world coordinate system (WCS) projection for texture mapping. Notice: If this texture is used by an object that has an object coordinate system (OCS) frame defined on a mapping channel then that OCS frame is used instead of the WCS.

Public Property

WrapU

Texture wrapping mode in the U direction

Public Property

WrapV

Texture wrapping mode in the V direction

Public Property

WrapW

Texture wrapping mode in the W direction

Methods

Name

Description

Protected Method

ConstructConstObject

Assigns a parent object and a sub-object index to this.

(Inherited from CommonObject.)

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

(Inherited from CommonObject.)

Public Method

EnsurePrivateCopy

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

(Inherited from CommonObject.)

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from CommonObject.)

Public Method

GetAlphaBlendValues

If the TextureCombineMode is Blend, then the blending function for alpha is determined by

new alpha = constant + a0*(current alpha) + a1*(texture alpha) + a2*min(current alpha,texture alpha) + a3*max(current alpha,texture alpha)

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

(Inherited from CommonObject.)

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

(Inherited from CommonObject.)

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Protected Method

NonConstOperation

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

(Inherited from CommonObject.)

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

(Inherited from CommonObject.)

Public Method

SetAlphaBlendValues

If the TextureCombineMode is Blend, then the blending function for alpha is determined by

new alpha = constant + a0*(current alpha) + a1*(texture alpha) + a2*min(current alpha,texture alpha) + a3*max(current alpha,texture alpha)

Public Method

SetRGBBlendValues

If the TextureCombineMode is Blend, then the blending function for RGB is determined by

new rgb = colorcolor + a0[0]*(current RGB) + a1[1]*(texture RGB) + a2[2]*min(current RGB,texture RGB) + a3[3]*max(current RGB,texture RGB)

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)