RhinoCommon API

TextureMapping Class

Represents a texture mapping.

Inheritance Hierarchy

SystemObject
Rhino.RuntimeCommonObject
Rhino.RenderTextureMapping

Namespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

Copy

public class TextureMapping : CommonObject

Public Class TextureMapping
	Inherits CommonObject

The TextureMapping type exposes the following members.

Properties

	Name	Description
	ComponentStatus	Gets or sets the component status of the model component. (Inherited from ModelComponent.)
	ComponentType	Returns TextureMapping. (Overrides ModelComponentComponentType.)
	DeletedName	Gets the name of a component that is deleted. (Inherited from ModelComponent.)
	Disposed	Indicates if this object has been disposed or the document it originally belonged to has been disposed. (Inherited from CommonObject.)
	HasId	Returns a value indicating whether the component has an ID. (Inherited from ModelComponent.)
	HasIndex	Returns a value indicating whether the component has an Index. (Inherited from ModelComponent.)
	HasName	Returns a value indicating whether the component has a Name. (Inherited from ModelComponent.)
	HasUserData	Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.)
	Id	The unique Id for this texture mapping object.
	IdIsLocked	Returns a value indicating whether the component ID is already locked. (Inherited from ModelComponent.)
	Index	Gets or sets the model component index attribute. (Inherited from ModelComponent.)
	IndexIsLocked	Returns a value indicating whether the component Index is already locked. (Inherited from ModelComponent.)
	InstanceDefinitionModelSerialNumber	When a component is in a model as part of the information required for a linked instance definition, this value identifies the the linked instance definition reference model. (Inherited from ModelComponent.)
	IsComponentStatusLocked	The component status itself can be locked. This returns an indication. (Inherited from ModelComponent.)
	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.)
	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.)
	IsValid	Tests an object to see if it is valid. (Inherited from CommonObject.)
	MappingType	Texture mapping type associated with this Mapping object.
	ModelSerialNumber	A value identifing the model that manages this component. (Inherited from ModelComponent.)
	Name	Gets or sets the name (Inherited from ModelComponent.)
	NameIsLocked	Returns a value indicating whether the component Name is already locked. (Inherited from ModelComponent.)
	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.
	PrimativeTransform	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.
	ReferenceModelSerialNumber	When a component is in a model for reference, this value identifies the reference model. (Inherited from ModelComponent.)
	UserData	List of custom information that is attached to this class. (Inherited from CommonObject.)
	UserDictionary	Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information. (Inherited from CommonObject.)
	UvwTransform	Transform applied to mapping coordinate (u,v,w) to convert it into a texture coordinate.

Top

Methods

	Name	Description
	ClearId	Resets the HasId property of the model component to false, if possible. (Inherited from ModelComponent.)
	ClearIndex	Resets the HasIndex property of the model component to false, if possible. (Inherited from ModelComponent.)
	ClearName	Resets the HasName property of the model component to false, if possible. (Inherited from ModelComponent.)
	ConstructConstObject	Assigns a parent object and a subobject index to this. (Inherited from CommonObject.)
	CreateBoxMapping	Create a box projection texture mapping.
	CreateCylinderMapping	Create a cylindrical projection texture mapping.
	CreatePlaneMapping(Plane, Interval, Interval, Interval)	Create a planar UV projection texture mapping
	CreatePlaneMapping(Plane, Interval, Interval, Interval, Boolean)	Create a planar projection texture mapping
	CreateSphereMapping	Create a spherical projection texture mapping.
	DataCRC	Increments the Cyclic Redundancy Check value by this instance. (Inherited from ModelComponent.)
	Dispose	Actively reclaims unmanaged resources that this instance uses. (Inherited from CommonObject.)
	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.)
	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.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Inherited from CommonObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. (Inherited from CommonObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValidWithLog	Determines if an object is valid. Also provides a report on errors if this object happens not to be valid. (Inherited from CommonObject.)
	LockId	Locks the component Id property. (Inherited from ModelComponent.)
	LockIndex	Locks the component Index property. (Inherited from ModelComponent.)
	LockName	Locks the component Name property. (Inherited from ModelComponent.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NonConstOperation	For derived classes implementers. Defines the necessary implementation to free the instance from being const. (Inherited from CommonObject.)
	OnSwitchToNonConst	Is called when a non-const operation first occurs. (Inherited from CommonObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToString	Returns the name of the model component type, and then its name and index. (Inherited from ModelComponent.)
	TryGetMappingBox(Plane, Interval, Interval, Interval)	Get a box projection from the texture mapping.
	TryGetMappingBox(Plane, Interval, Interval, Interval, Boolean)	Get a box projection from the texture mapping, including capped information
	TryGetMappingCylinder(Cylinder)	Get a cylindrical projection parameters from this texture mapping.
	TryGetMappingCylinder(Cylinder, Boolean)	Get a cylindrical projection parameters from this texture mapping.
	TryGetMappingPlane(Plane, Interval, Interval, Interval)	Get plane mapping parameters from this texture mapping.
	TryGetMappingPlane(Plane, Interval, Interval, Interval, Boolean)	Get plane mapping parameters from this texture mapping, including capping information
	TryGetMappingSphere	Get a spherical projection parameters from this texture mapping.

Top

Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.14

Reference

Rhino.Render Namespace

Report wishes and bugs at discourse.mcneel.com