TextureMapping

Public Class

Represents a texture mapping.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.ModelComponent
Rhino.Render.TextureMapping

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class TextureMapping : ModelComponent

The TextureMapping type exposes the following members.

Properties

Name

Description

Public Property

ComponentStatus

Gets or sets the component status of the model component.

(Inherited from ModelComponent.)

Public Property

ComponentType

Returns TextureMapping.

(Overrides

ModelComponent.ComponentType

Public Property

DeletedName

Gets the name of a component that is deleted.

(Inherited from ModelComponent.)

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

HasId

Returns a value indicating whether the component has an ID.

(Inherited from ModelComponent.)

Public Property

HasIndex

Returns a value indicating whether the component has an Index.

(Inherited from ModelComponent.)

Public Property

HasName

Returns a value indicating whether the component has a Name.

(Inherited from ModelComponent.)

Public Property

HasUserData

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

(Inherited from CommonObject.)

Public Property

The unique Id for this texture mapping object.

(Overrides

ModelComponent.Id

Public Property

IdIsLocked

Returns a value indicating whether the component ID is already locked.

(Inherited from ModelComponent.)

Public Property

Index

Gets or sets the model component index attribute.

(Inherited from ModelComponent.)

Public Property

IndexIsLocked

Returns a value indicating whether the component Index is already locked.

(Inherited from ModelComponent.)

Public Property
InstanceDefinitionModelSerialNumber

When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.

(Inherited from ModelComponent.)

Public Property

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.

(Inherited from ModelComponent.)

Public Property

IsDeleted

true if the component is deleted. Deleted components are kept by the document for undo purposes.

(Inherited from ModelComponent.)

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

IsReference

Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.

(Inherited from ModelComponent.)

Public Property

IsSystemComponent

True if this model component is a system constant.

An incomplete list of system constant model components is below:

ON_ModelComponent::Unset
ON_InstanceDefinition::Empty
ON_Linetype::Unset
ON_Linetype::Continuous
ON_Linetype::ByLayer
ON_Linetype::ByParent
ON_Layer::Unset
ON_Layer::Default
ON_TextStyle::Unset
ON_TextStyle::Default
ON_TextStyle::ByLayer
ON_TextStyle::ByParent
ON_DimStyle::Unset
ON_DimStyle::Default
ON_DimStyle::DefaultInchDecimal
ON_DimStyle::DefaultInchFractional
ON_DimStyle::DefaultFootInchArchitecture
ON_DimStyle::DefaultMillimeterSmall
ON_DimStyle::DefaultMillimeterLarge
ON_DimStyle::DefaultMillimeterArchitecture

(Inherited from ModelComponent.)

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

Public Property

MappingType

Texture mapping type associated with this Mapping object.

Public Property
ModelSerialNumber

A value identifying the model that manages this component.

(Inherited from ModelComponent.)

Public Property
Code Example

Name

Gets or sets the name

(Inherited from ModelComponent.)

Public Property

NameIsLocked

Returns a value indicating whether the component Name is already locked.

(Inherited from ModelComponent.)

Public Property

NormalTransform

For primitive based mappings, these transformations are used to map the world coordinate (x,y,z) point P and surface normal N before it is projected to the normalized mapping primitive. The surface normal transformation, m_Nxyz, is always calculated from m_Pxyz. It is a runtime setting that is not saved in 3dm files. If m_type is srfp_mapping, then m_Pxyz and m_Nxyz are ignored.

Public Property

PrimativeTransform

Obsolete.

Public Property

PrimitiveTransform

Public Property
ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.

(Inherited from ModelComponent.)

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 applied to mapping coordinate (u,v,w) to convert it into a texture coordinate.

Methods

Name

Description

Public Method

ClearId

Resets the HasId property of the model component to false, if possible.

(Inherited from ModelComponent.)

Public Method

ClearIndex

Resets the HasIndex property of the model component to false, if possible.

(Inherited from ModelComponent.)

Public Method

ClearName

Resets the HasName property of the model component to false, if possible.

(Inherited from ModelComponent.)

Public Method
Static Member
CreateBoxMapping

Create a box projection texture mapping.

Public Method
Static Member

CreateCustomMeshMapping

Create custom mesh mapping

Public Method
Static Member
CreateCylinderMapping

Create a cylindrical projection texture mapping.

Public Method
Static Member

CreateOcsMapping

Create a Ocs texture mapping. Note that OCS mappings must be placed on mapping channel ON_ObjectRenderingAttributes::OCSMappingChannelId() otherwise they will not work.

Public Method
Static Member

CreatePlaneMapping(Plane, Interval, Interval, Interval)

Create a planar UV projection texture mapping

Public Method
Static Member

CreatePlaneMapping(Plane, Interval, Interval, Interval, Boolean)

Create a planar projection texture mapping

Public Method
Static Member

CreateSphereMapping

Create a spherical projection texture mapping.

Public Method
Static Member

CreateSurfaceParameterMapping

Create a mapping that will convert surface parameters into normalized(0,1)x(0,1) texture coordinates.

Public Method

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

(Inherited from ModelComponent.)

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

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

Public Method

Evaluate(Point3d, Vector3d, Point3d.)

Evaluate the mapping to get a texture coordinate

Public Method

Evaluate(Point3d, Vector3d, Point3d., Transform, Transform)

Evaluate the mapping to get a texture coordinate

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

Public Method

LockId

Locks the component Id property.

(Inherited from ModelComponent.)

Public Method

LockIndex

Locks the component Index property.

(Inherited from ModelComponent.)

Public Method

LockName

Locks the component Name property.

(Inherited from ModelComponent.)

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

Public Method
ToString

Returns the name of the model component type, and then its name and index.

(Inherited from ModelComponent.)

Public Method
TryGetMappingBox(Plane., Interval., Interval., Interval.)

Get a box projection from the texture mapping.

Public Method
TryGetMappingBox(Plane., Interval., Interval., Interval., Boolean.)

Get a box projection from the texture mapping, including capped information

Public Method
TryGetMappingCylinder(Cylinder.)

Get a cylindrical projection parameters from this texture mapping.

Public Method
TryGetMappingCylinder(Cylinder., Boolean.)

Get a cylindrical projection parameters from this texture mapping.

Public Method

TryGetMappingMesh

Get custom mapping mesh from this texture mapping.

Public Method
TryGetMappingPlane(Plane., Interval., Interval., Interval.)

Get plane mapping parameters from this texture mapping.

Public Method
TryGetMappingPlane(Plane., Interval., Interval., Interval., Boolean.)

Get plane mapping parameters from this texture mapping, including capping information

Public Method
TryGetMappingSphere

Get a spherical projection parameters from this texture mapping.