Key of an effect parameter. More...

Inheritance diagram for SiliconStudio.Paradox.Effects.ParameterKey:

Public Member Functions
override bool	Equals (object obj)
	Determines whether the specified System.Object is equal to this instance. More...

override int	GetHashCode ()
	Returns a hash code for this instance. More...

virtual ParameterKey	CloneLength (int length)

object	ConvertValue (object value)
	Converts the value passed by parameter to the expecting value of this parameter key (for example, if value is an integer while this parameter key is expecting a float) More...

Public Member Functions inherited from SiliconStudio.Core.PropertyKey
int	CompareTo (object obj)

Static Public Member Functions
static bool	operator== (ParameterKey left, ParameterKey right)
	Implements the operator ==. More...

static bool	operator!= (ParameterKey left, ParameterKey right)
	Implements the operator !=. More...

Public Attributes
ulong	HashCode

readonly ParameterKeyMetadata	DefaultMetadata

Protected Member Functions
	ParameterKey (Type propertyType, string name, int length, ParameterKeyMetadata parameterKeyMetadata)
	Initializes a new instance of the ParameterKey class. More...

Protected Member Functions inherited from SiliconStudio.Core.PropertyKey
	PropertyKey (string name, Type propertyType, Type ownerType, params PropertyKeyMetadata[] metadatas)
	Initializes a new instance of the PropertyKey class. More...

Properties
int	Length `[get, set]`
	Gets the number of elements for this key. More...

Properties inherited from SiliconStudio.Core.PropertyKey
string	Name `[get, set]`
	Gets the name of this key. More...

DefaultValueMetadata	DefaultValueMetadata `[get, set]`
	Gets the default value metadata. More...

ValidateValueMetadata	ValidateValueMetadata `[get, set]`
	Gets the validate value metadata (may be null). More...

ObjectInvalidationMetadata	ObjectInvalidationMetadata `[get, set]`
	Gets the object invalidation metadata (may be null). More...

AccessorMetadata	AccessorMetadata `[get, set]`
	Gets the accessor metadata (may be null). More...

PropertyKeyMetadata[]	Metadatas `[get, set]`
	Gets the metadatas. More...

Type	OwnerType `[get, set]`
	Gets the type of the owner. More...

Type	PropertyType `[get, set]`
	Gets the type of the property. More...

abstract bool	IsValueType `[get]`

Detailed Description

Key of an effect parameter.

Definition at line 15 of file ParameterKey.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Effects.ParameterKey.ParameterKey	(	Type	propertyType,
		string	name,
		int	length,
		ParameterKeyMetadata	parameterKeyMetadata
	)

protected

Initializes a new instance of the ParameterKey class.

Parameters

name	The name.
parameterKeyMetadata	Associated metadatas

Definition at line 24 of file ParameterKey.cs.

Member Function Documentation

virtual ParameterKey SiliconStudio.Paradox.Effects.ParameterKey.CloneLength ( int length )

virtual

Reimplemented in SiliconStudio.Paradox.Effects.ParameterKey< T >.

Definition at line 115 of file ParameterKey.cs.

object SiliconStudio.Paradox.Effects.ParameterKey.ConvertValue ( object value )

Converts the value passed by parameter to the expecting value of this parameter key (for example, if value is an integer while this parameter key is expecting a float)

Parameters

value The value.

Returns: System.Object.

Definition at line 139 of file ParameterKey.cs.

override bool SiliconStudio.Paradox.Effects.ParameterKey.Equals ( object obj )

Determines whether the specified System.Object is equal to this instance.

Parameters

obj	The System.Object to compare with this instance.

Returns: true if the specified System.Object is equal to this instance; otherwise, false.

Definition at line 66 of file ParameterKey.cs.

override int SiliconStudio.Paradox.Effects.ParameterKey.GetHashCode ( )

Returns a hash code for this instance.

Returns: A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Definition at line 82 of file ParameterKey.cs.

static bool SiliconStudio.Paradox.Effects.ParameterKey.operator!=	(	ParameterKey	left,
		ParameterKey	right
	)

static

Implements the operator !=.

Parameters

left	The left.
right	The right.

Returns: The result of the operator.

Definition at line 108 of file ParameterKey.cs.

static bool SiliconStudio.Paradox.Effects.ParameterKey.operator==	(	ParameterKey	left,
		ParameterKey	right
	)

static

Implements the operator ==.

Parameters

left	The left.
right	The right.

Returns: The result of the operator.

Definition at line 95 of file ParameterKey.cs.

Member Data Documentation

readonly ParameterKeyMetadata SiliconStudio.Paradox.Effects.ParameterKey.DefaultMetadata

Definition at line 35 of file ParameterKey.cs.

ulong SiliconStudio.Paradox.Effects.ParameterKey.HashCode

Definition at line 17 of file ParameterKey.cs.

Property Documentation

int SiliconStudio.Paradox.Effects.ParameterKey.Length

getset

Gets the number of elements for this key.

Definition at line 40 of file ParameterKey.cs.

Referenced by SiliconStudio.Paradox.Effects.ParameterCollection.SetArray< T >().

The documentation for this class was generated from the following file:

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox/Effects/ParameterKey.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation