KeyedAttributeVariable<System.Boolean> Class

Represents a value, of type System.Boolean, that is generated by using a specific attribute value as a key into a lookup table which maps attribute values to return values.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public class KeyedAttributeVariable< System.Boolean > : 
	AttributeVariable< System.Boolean >

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 System.Boolean 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<System.Boolean>
      KeyedAttributeVariable<System.Boolean>

Platforms

Windows, Linux, Android

KeyedAttributeVariable<System.Boolean> Members

The KeyedAttributeVariable<System.Boolean> type has the following members.

Constructors

Name	Description
KeyedAttributeVariable<System::Boolean>	Initializes a new instance of the KeyedAttributeVariable<System.Boolean> 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<System.Boolean> has a default value.
IsDisposed	Gets a value that tells whether the current KeyedAttributeVariable<System.Boolean> 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<System.Boolean> represents. Inherited from EngineObject
Table	Gets the lookup table that maps attribute values to System.Boolean 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<System.Boolean>

KeyedBoolAttributeVariable Class

Represents a value, of type bool, that is generated by using a specific attribute value as a key into a lookup table which maps attribute values to return values.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class KeyedBoolAttributeVariable : public BoolAttributeVariable

C++ Smart Pointer Declaration

typedef Ptr<KeyedBoolAttributeVariable> KeyedBoolAttributeVariablePtr;

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 bool 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

EngineObject
BoolAttributeVariable
KeyedBoolAttributeVariable

Platforms

Windows, Linux, Android

KeyedBoolAttributeVariable Members

The KeyedBoolAttributeVariable type has the following members.

Constructors

Name	Description
KeyedBoolAttributeVariable	Initializes a new instance of the KeyedBoolAttributeVariable 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 KeyedBoolAttributeVariable has a default value.
key	Gets or sets the Atom that specifies which attribute value is used as a key into the lookup table.
table	Gets the lookup table that maps attribute values to bool values.

Methods

Name	Description
clearDefaultValue	Clears the default value.
clone	Creates a copy of an object. 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 BoolAttributeVariable

KeyedBoolAttributeVariable Class

Represents a value, of type boolean, that is generated by using a specific attribute value as a key into a lookup table which maps attribute values to return values.

Package: com.carmenta.engine.core
JAR file: CECore.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class KeyedBoolAttributeVariable extends BoolAttributeVariable

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 boolean 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 Java)
  EngineObject
    BoolAttributeVariable
      KeyedBoolAttributeVariable

Platforms

Windows, Linux, Android

KeyedBoolAttributeVariable Members

The KeyedBoolAttributeVariable type has the following members.

Constructors

Name	Description
KeyedBoolAttributeVariable	Initializes a new instance of the KeyedBoolAttributeVariable 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 KeyedBoolAttributeVariable has a default value.
isDisposed	Gets a value that tells whether the current KeyedBoolAttributeVariable 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.
table	Gets the lookup table that maps attribute values to boolean 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 BoolAttributeVariable

KeyedBoolAttributeVariable Class

Represents a value, of type bool, that is generated by using a specific attribute value as a key into a lookup table which maps attribute values to return values.

Module: Carmenta.Engine.Core (in Core.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class KeyedBoolAttributeVariable ( BoolAttributeVariable )

Remarks

Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.

Inheritance Hierarchy

EngineObject
BoolAttributeVariable
KeyedBoolAttributeVariable

Platforms

Windows, Linux, Android

KeyedBoolAttributeVariable Members

The KeyedBoolAttributeVariable type has the following members.

Constructors

Name	Description
KeyedBoolAttributeVariable	Initializes a new instance of the KeyedBoolAttributeVariable 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 KeyedBoolAttributeVariable has a default value.
key	Gets or sets the Atom that specifies which attribute value is used as a key into the lookup table.
table	Gets the lookup table that maps attribute values to bool values.

Methods

Name	Description
clearDefaultValue	Clears the default value.
clone	Creates a copy of an object. 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 BoolAttributeVariable

KeyedAttributeVariable<System.Boolean> Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedAttributeVariable<System.Boolean> Members

KeyedBoolAttributeVariable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedBoolAttributeVariable Members

KeyedBoolAttributeVariable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedBoolAttributeVariable Members

KeyedBoolAttributeVariable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedBoolAttributeVariable Members