KeyedAttributeVariable<Material> Class
Represents a value, of type Material, that is generated by using a specific attribute value as a key into a lookup table which maps attribute values to return values.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class KeyedAttributeVariable< Material > :
AttributeVariable< Material >Remarks
This type is used to represent attribute controlled values in visualizers and operators that are generated by taking the attribute value specified by the Key property and using it as a key into the lookup table, accessed through the Table property, which results in the final Material value that is returned by the attribute variable.
Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
AttributeVariable<Material>
KeyedAttributeVariable<Material>
Platforms
Windows, Linux, Android
KeyedAttributeVariable<Material> Members
The KeyedAttributeVariable<Material> type has the following members.
Constructors
| Name | Description |
|---|---|
| KeyedAttributeVariable<Material> | Initializes a new instance of the KeyedAttributeVariable<Material> class. |
Properties
| Name | Description |
|---|---|
| DefaultValue | Gets or sets the default value that is returned if an AttributeSet does not contain the attribute specified by the Key property. It may also be returned if the key type is string, atom or bool, and no exact match for the attribute value is found in the lookup table. |
| HasDefaultValue | Gets a value that tells whether the KeyedAttributeVariable<Material> has a default value. |
| IsDisposed | Gets a value that tells whether the current KeyedAttributeVariable<Material> has been disposed. Inherited from EngineObject |
| Key | Gets or sets the Atom that specifies which attribute value is used as a key into the lookup table. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current KeyedAttributeVariable<Material> represents. Inherited from EngineObject |
| Table | Gets the lookup table that maps attribute values to Material values. |
Methods
| Name | Description |
|---|---|
| ClearDefaultValue | Clears the default value. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| TryGetValue | Tries to generate a value from the specified AttributeSet. Inherited from AttributeVariable<Material> |