Class Scene.Object.FinishesConfig

Represents finishes config, which is in essence a set of available finish types and one assigned finish assigned to each of them.

Inheritance

object

Scene.Object.FinishesConfig

Implements

IEnumerable<Scene.Object.Finish>

IEnumerable

IEquatable<Scene.Object.FinishesConfig>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: KD.SDK2

Assembly: KD.SDK2.dll

Syntax

public class Scene.Object.FinishesConfig : IEnumerable<Scene.Object.Finish>, IEnumerable, IEquatable<Scene.Object.FinishesConfig>

Remarks

This class operates on a finishes config string which can be obtained for example from FinishesConfigString property.

Constructors

Name	Description
FinishesConfig(Object, string)	Instantiates FinishesConfig object from an object to which finishes config string belongs to, and finishes config string itself.

Properties

Name	Description
FinishTypes	Provides access to the finish types available in the finishes config.
Finishes	Provides access to all the finishes that are set in the finishes config.
this[FinishType]	Allows to access a finish by its finish type.

Methods

Name	Description
Equals(FinishesConfig)	Compares two instances based on their internal finishes config string representation.
Equals(object)	Compares two instances based on their internal finishes config string representation.
GetEnumerator()	Implements IEnumerable<Appli.CatalogFinish> for enumerating the finishes.
GetFinishTypeByName(string)	Gets finish type from the finishes config by its name. Throws an exception if given name doesn't exist in finishes config.
GetHashCode()	Generates instance hash code based on the internal string representation.
SetFinishByTypeNameAndCode(string, string)	Finds a finish type with given name in the finishes config, then finds a finish with given code belonging to the finish type, and then sets the finish to the config.
ToString()	Returns string representation of the finishes config.
TryGetFinish(FinishType, out Finish)	Tries to get finish for given finish type.
TryGetFinishTypeByName(string, out FinishType)	Tries to get finish type with given name from the finishes config.
TrySetFinish(FinishType, Finish)
TrySetFinishByTypeNameAndCode(string, string)	Finds a finish type with given name in the finishes config, then finds a finish with given code belonging to the finish type, and then sets the finish to the config.

Operators

Name	Description
operator ==(FinishesConfig, FinishesConfig)	Determines whether two specified instances have the same value.
operator !=(FinishesConfig, FinishesConfig)	Determines whether two specified instances have different values.

See Also

GetFinishesConfig()