SurfaceModel Class |
The Surface element represents an object's surface on which other objects can be placed.
Inheritance Hierarchy
SystemObject
Livit.Learn.ModelBaseModel
Livit.Learn.ModelTriggableModel
Livit.Learn.ModelScopeableModel
Livit.Learn.ModelViewableModel
Livit.Learn.ModelStateableModel
Livit.Learn.ModelFocusableModel
Livit.Learn.ModelDraggableModel
Livit.Learn.ModelElementModel
Livit.Learn.ModelSurfaceModel
Livit.Learn.ModelBaseModel
Livit.Learn.ModelTriggableModel
Livit.Learn.ModelScopeableModel
Livit.Learn.ModelViewableModel
Livit.Learn.ModelStateableModel
Livit.Learn.ModelFocusableModel
Livit.Learn.ModelDraggableModel
Livit.Learn.ModelElementModel
Livit.Learn.ModelSurfaceModel
Namespace: Livit.Learn.Model
Assembly: Livit.Learn.Model (in Livit.Learn.Model.dll) Version: 0.0.0.0
SyntaxC#
[SerializableAttribute] public class SurfaceModel : ElementModel
The SurfaceModel type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SurfaceModel | Initializes a new instance of the SurfaceModel class |
Properties| Name | Description | |
|---|---|---|
 | AccessibilityAnimationCategory | (Inherited from ElementModel.) |
| AccessibilityTooltip |
Sets the Accessibility tooltip displayed and narrated when in Accessibility Mode.
(Inherited from ElementModel.) |
| AllowHandRotation |
Daydream specific parameter.
Determines whether to allow hand rotation based on controller rotation or not. Defaults to true.
(Inherited from ElementModel.) |
| AllowPositionMarker | (Inherited from FocusableModel.) |
| AllowTrashing |
Allows the element to be trashed.
(Inherited from ElementModel.) |
| Attached |
Defines an attached property.
(Inherited from BaseModel.) |
 | BasedOn |
References another element from which the current element's parameters will be based.
(Inherited from ElementModel.) |
| ClickCount |
Counts the number of times an element has been clicked on.
(Inherited from ElementModel.) |
| Comments |
(Development) Includes comments in the XML code.
(Inherited from BaseModel.) |
| CustomCameras |
CustomCameras for this Foucsable
(Inherited from FocusableModel.) |
| CustomCamerasSerialized | (Inherited from FocusableModel.) |
| DataContext |
Contains a source of all bindings defined for element.
(Inherited from BaseModel.) |
| Decals |
Applies a decal on the parent element.
(Inherited from ElementModel.) |
| DecalsSerialized | (Inherited from ElementModel.) |
| DefaultExtendedTooltip |
Sets the extended tooltip displayed when the element is hovered over.
(Inherited from ElementModel.) |
| DefaultTooltip |
Sets the tooltip displayed when the element is hovered over. If an image URL is added the image will be displayed in the tooltip.
(Inherited from ElementModel.) |
| Description |
Displays a description of the object to the user.
(Inherited from TriggableModel.) |
| DragLineColor | (Inherited from DraggableModel.) |
| DragLineColorSerialized |
Defines the color of the drag line
Default value : White
(Inherited from DraggableModel.) |
| DragLineOn |
To show drag line. If TRUE, drag line is displayed
(Inherited from DraggableModel.) |
| DragLineThickness |
The thickness of the drag line
(Inherited from DraggableModel.) |
| DragModeThreshold |
Minimal distance the User has to move the mouse to any direction while holding the mouse button in order to activate Dragging mode
(Inherited from DraggableModel.) |
| DragSpeed | (Inherited from DraggableModel.) |
| DragSpeedSerialized | (Inherited from DraggableModel.) |
| Elements |
Establishes a collection of child elements.
(Inherited from ElementModel.) |
| ElementsSerialized | (Inherited from ElementModel.) |
| EmphasisDuration |
Duration of an element's emphasizing in the scene.
(Inherited from ViewableModel.) |
| ExternalXmlPath | (Inherited from BaseModel.) |
| Fields | (Inherited from ScopeableModel.) |
| FieldsSerialized | (Inherited from ScopeableModel.) |
| GameObjectId |
(Optional) Defines what the GameObject should be named.
(Inherited from FocusableModel.) |
| GUITooltipId |
Specifies the GUI tooltip template used for this element.
(Inherited from ElementModel.) |
| Id |
Defines a unique identifier for an element in the simulation.
(Inherited from BaseModel.) |
| InheritTemperature |
Inherits the parent's Temperature.
(Inherited from ElementModel.) |
| IsAlwaysNavigable |
Ensures that Element auto-discovered for accessibility navigation and circumvent non-critical checks blocking it from being navigable otherwise.
(Inherited from ElementModel.) |
| IsClickable |
Allows the object to be clicked if the parent element is focused.
(Inherited from ElementModel.) |
| IsDraggable |
Set on the object that enables/disables if the object can be dragged or not
(Inherited from DraggableModel.) |
| IsDropAllowed |
Allows the element to be dropped by the user.
(Inherited from ElementModel.) |
| IsFocusable |
Allows an element to be focused on.
(Inherited from FocusableModel.) |
| IsFreeLook |
Allows the object to be viewed by the user from any angle.
(Inherited from FocusableModel.) |
| IsHighlightable |
Highlights the object when the mouse hovers over it.
(Inherited from ElementModel.) |
| IsIdAutogenerated | (Inherited from BaseModel.) |
| IsPickUpAllowed |
Allows the element to be picked up by the user.
(Inherited from ElementModel.) |
| IsScope | (Inherited from ScopeableModel.) |
| IsVisible | (Inherited from ViewableModel.) |
| KeepExamineOnInteraction |
Allows an element to stay focused even after an interaction.
(Inherited from FocusableModel.) |
| Mass |
(In development) Sets the element's mass.
(Inherited from ElementModel.) |
| MessageHandlers | (Inherited from ScopeableModel.) |
| MessageHandlersSerialized | (Inherited from ScopeableModel.) |
| Parameters |
Defines a collection of parameters for the element.
(Inherited from ElementModel.) |
| ParametersSerialized | (Inherited from ElementModel.) |
| Position |
Positions the element on its parent element's surface.
(Inherited from ElementModel.) |
| PositionSerialized | (Inherited from ElementModel.) |
| Rotation |
Sets the rotation of the element on the parent surface.
(Inherited from ElementModel.) |
| RotationSerialized | (Inherited from ElementModel.) |
| Screens |
Specifies the GUI used to interact with this element.
(Inherited from ElementModel.) |
| ScreensSerialized | (Inherited from ElementModel.) |
| SourceId |
Specifies the ID of the GameObject asset to be loaded.
(Inherited from ElementModel.) |
| StateGroups |
Defines the possible StateGroup for this element.
(Inherited from StateableModel.) |
| StateGroupsSerialized | (Inherited from StateableModel.) |
| SurfaceOffset |
The element's distance from the surface.
(Inherited from ElementModel.) |
| Tags | (Inherited from ViewableModel.) |
| TargetHighlight |
Highlights all placeholders that accept dragged object
(Inherited from DraggableModel.) |
| Temperature |
(In development) The element's temperature.
(Inherited from ElementModel.) |
| TemplateVersionId |
Contains a id of source template.
(Inherited from BaseModel.) |
| TintColor |
Sets the tint of the element.
(Inherited from ElementModel.) |
| TintColorSerialized | (Inherited from ElementModel.) |
| Title |
Defines a title for the object.
(Inherited from TriggableModel.) |
| Triggers | (Inherited from TriggableModel.) |
| TriggersSerialized |
Lists the available Triggers for
this object.
(Inherited from TriggableModel.) |
| Visit |
Counts the number of visits to the a scene.
(Inherited from FocusableModel.) |
| WasShown |
(Internal use only) Returns true if the object has been shown in the simulation.
(Inherited from ViewableModel.) |
| XmlComments |
(Development) Used as temporary storage for XML comments (like ) to keep them.
(Inherited from BaseModel.) |
Methods| Name | Description | |
|---|---|---|
| DeepCopy |
Creates an in-memory clone of this object using a BinaryFormatter to ensure all child properties are copied as well.
(Inherited from BaseModel.) |
| ShallowCopy | (Inherited from BaseModel.) |
| ShouldSerializeStateGroups | (Inherited from StateableModel.) |
| ShouldSerializeTriggers | (Inherited from TriggableModel.) |
| ToString |
Returns a string that represents the current object.
(Inherited from BaseModel.) |
| UpdateModels |
This method will update this model and all its child models.
(Inherited from BaseModel.) |
RemarksThe Surface is part of the object's asset and does not need to be created manually. Its GameObjectId can be found after placing the object in the simulation and checking in Unity (this does not apply when using the Builder, which declares the surface automatically).
The GameObjectId of the Surface must be declared in order for objects to have the proper y-axis position.
The Surface must have a 1,1,1 scale when designed by the Art department.
See Also