Class Scene.Generic
Represents a finishes configuration, which is inherited by objects of a scene (fully or partially).
Implements
Inherited Members
Namespace: KD.SDK2
Assembly: KD.SDK2.dll
Syntax
public class Scene.Generic : IEquatable<Scene.Generic>
Remarks
Generic can be configured via "Scene|Generic finishes..." KitchenDraw menu item. There is at least one generic for every single KitchenDraw catalog that is used in a scene. Usually first generic is added to the scene on the second step of new scene creation when "Generic finishes" dialog appears to allow to choose default catalog, model and colours for the scene being created. Generic is created when user drops some object into a scene from the catalog that wasn't used in the scene yet. The same "Generic finishes" catalog appears in the KitchenDraw interface at this moment. In addition to that, a user can create additional generics at his descretion thanks to "New" button in the bottom of the "Generic finishes" dialog. A user can delete finishes with "Delete" button at the same area, but only if the generic being deleted is not used by any object any more.
Caution! The internal implementation of Generic class is based in generic ranks in the scene generics list. Because of that, using InsertGeneric(string, Generic) and RemoveGeneric(Generic) methods invalidates the internal structure of the existing generic instances, and you may get data from foreign generic while reading Generic class instance properties. Please be aware of that and recreate Generic class instances if necessary after you insert/delete generics in the scene.
Constructors
Name | Description |
---|---|
Generic(Scene, int) | Constructs an instance of the Generic class to provide access to a generic with given rank in a scene. |
Properties
Name | Description |
---|---|
CatalogFilename | Filename of the catalog, for which the generic is defined. |
FinishesConfigString | The character string representing the finishes configuration of the generic. |
Rank | Rank of the generic in the scene (zero-based). |
Methods
Name | Description |
---|---|
Equals(Generic) | Determines whether passed instance has the same value as this one. |
Equals(object) | Determines whether passed object has the same type and value as this one. |
GetFinishesConfig() | Gets the finishes configuration of the generic. Modifying the returned Scene.FinishesConfig instance does not affect the generic. See Scene.FinishesConfig for more details. |
GetHashCode() | Provides a numeric value that is used to identify an object in hash-based algorithms. |
Operators
Name | Description |
---|---|
operator ==(Generic, Generic) | Determines whether two specified instances have the same value. |
operator !=(Generic, Generic) | Determines whether two specified instances have different values. |