Represents a texture that is mapped on objects.

Constructors

Texture

#Since v5.0
Initializes a new texture.
public Texture()

Texture

#
Protected constructor for internal use.
protected Texture(
info,
Serialization data.
context
Serialization stream.
)

Properties

ApplyUvwTransform

#Since v5.6
If true then the UVW transform is applied to the texture otherwise the UVW transform is ignored.
public bool ApplyUvwTransform { get; set; }

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

Enabled

#Since v5.0
If the texture is enabled then it will be visible in the rendered display otherwise it will not.
public bool Enabled { get; set; }

FileName

#Since v5.0
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 string FileName { get; set; }

FileReference

#Since v6.0
Gets or sets a copy of the file reference that is used by this texture. After the get or the set method complete, you own the copy you received or passed in, and can Dispose() of it.
public FileReference FileReference { get; set; }

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

Id

#Since v5.0
Gets the globally unique identifier of this texture.
public Guid Id { get; }

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.
public virtual bool IsDocumentControlled { get; }
inherited fromCommonObject

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

MagFilter

#Since v8.3
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 TextureFilter MagFilter { get; set; }

MappingChannelId

#Since v5.10
public int MappingChannelId { get; }

MinFilter

#Since v8.3
The MinFilter setting controls how the color of the image pixel is calculated when the image pixel corresponds to multiple texture bitmap pixels.
public TextureFilter MinFilter { get; set; }

Offset

#Since v8.0
Helper for access to the offset value encoded in UvwTransform
public Vector2d Offset { get; set; }

ProjectionMode

#Since v8.3
How texture is projected onto geometry
public TextureProjectionModes ProjectionMode { get; set; }

Repeat

#Since v8.0
Helper for access to the repeat value encoded in UvwTransform
public Vector2d Repeat { get; set; }

Rotation

#Since v8.0
Helper for access to the rotation value encoded in UvwTransform
public double Rotation { get; set; }

TextureCombineMode

#Since v5.6
Determines how this texture is combined with others in a material's texture list.
public TextureCombineMode TextureCombineMode { get; set; }

TextureType

#Since v5.6
Controls how the pixels in the bitmap are interpreted
public TextureType TextureType { get; set; }

TreatAsLinear

#Since v8.7
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 bool TreatAsLinear { get; set; }

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

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.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UvwTransform

#Since v5.6
Transform to be applied to each instance of this texture if ApplyUvw is true
public Transform UvwTransform { get; set; }

WcsBoxProjected

#Since v8.3
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 bool WcsBoxProjected { get; }

WcsProjected

#Since v8.3
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 bool WcsProjected { get; }

WrapU

#Since v5.6
Texture wrapping mode in the U direction
public TextureUvwWrapping WrapU { get; set; }

WrapV

#Since v5.6
Texture wrapping mode in the V direction
public TextureUvwWrapping WrapV { get; set; }

WrapW

#Since v5.6
Texture wrapping mode in the W direction
public TextureUvwWrapping WrapW { get; set; }

Methods

ConstructConstObject

Assigns a parent object and a sub-object index to this.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

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.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)
inherited fromCommonObject

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.
public void EnsurePrivateCopy()
inherited fromCommonObject

GetAlphaBlendValues

#Since v5.6
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 void GetAlphaBlendValues(
out double
constant,
out double
a0,
out double
a1,
out double
a2,
out double
a3
)

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
true if this object is valid; false otherwise.

NonConstOperation

For derived classes implementers.

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

protected virtual void NonConstOperation()
inherited fromCommonObject

OnSwitchToNonConst

Is called when a non-constant operation first occurs.
protected virtual void OnSwitchToNonConst()
inherited fromCommonObject

SetAlphaBlendValues

#Since v5.6
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 void SetAlphaBlendValues(
constant,
a0,
a1,
a2,
a3
)

SetRGBBlendValues

#Since v6.0
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 void SetRGBBlendValues(
color,
a0,
a1,
a2,
a3
)

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject