Language
Edit

DataCollectionItemPlacerOffset Class

Definition

A simple data collection item placer that will place each item at a specific offset from the previous object, first in the x, then y, then z directions, using the offsets provided in the inspector. The starting point is resetFReq each time a new placement session is started using StartPlacement().

[UnityEngine.AddComponentMenu("MRTK/Data Binding/Data Collection Item Placer Offset")]
public class DataCollectionItemPlacerOffset : MixedReality.Toolkit.Data.DataCollectionItemPlacerGOBase
[<UnityEngine.AddComponentMenu("MRTK/Data Binding/Data Collection Item Placer Offset")>]
type DataCollectionItemPlacerOffset = class
    inherit DataCollectionItemPlacerGOBase
Public Class DataCollectionItemPlacerOffset
Inherits DataCollectionItemPlacerGOBase
Inheritance
UnityEngine.MonoBehaviour
DataCollectionItemPlacerOffset
Attributes
UnityEngine.AddComponentMenuAttribute

Constructors

Name Description
DataCollectionItemPlacerOffset()

Fields

Name Description
_dataConsumerCollection (Inherited from DataCollectionItemPlacerGOBase)
_firstVisibleItem (Inherited from DataCollectionItemPlacerGOBase)
_itemPlacerPositionOffset
_itemsByState (Inherited from DataCollectionItemPlacerGOBase)
_itemStateByIndex (Inherited from DataCollectionItemPlacerGOBase)
_lastEventCollectionEmpty (Inherited from DataCollectionItemPlacerGOBase)
_lastEventCollectionNotEmpty (Inherited from DataCollectionItemPlacerGOBase)
_lastEventStateAtEnd (Inherited from DataCollectionItemPlacerGOBase)
_lastEventStateAtStart (Inherited from DataCollectionItemPlacerGOBase)
_lastEventStateCanGoBackward (Inherited from DataCollectionItemPlacerGOBase)
_lastEventStateCanGoForward (Inherited from DataCollectionItemPlacerGOBase)
_lastEventStateInMiddle (Inherited from DataCollectionItemPlacerGOBase)
_lastRequestDirection (Inherited from DataCollectionItemPlacerGOBase)
_lastRequestRangeCount (Inherited from DataCollectionItemPlacerGOBase)
_lastRequestRangeStart (Inherited from DataCollectionItemPlacerGOBase)
_numVisibleItems (Inherited from DataCollectionItemPlacerGOBase)
_totalItemCount (Inherited from DataCollectionItemPlacerGOBase)
collectionEvents (Inherited from DataCollectionItemPlacerGOBase)
debugMode (Inherited from DataCollectionItemPlacerGOBase)
itemOffset
keepGameObjectsInIndexOrder (Inherited from DataCollectionItemPlacerGOBase)
lastPageCanBePartial (Inherited from DataCollectionItemPlacerGOBase)
requestRef (Inherited from DataCollectionItemPlacerGOBase)
xCount
yCount
zCount

Methods

Name Description
AddItem(DataCollectionItemPlacerGOBase+State, Int32, String, GameObject) (Inherited from DataCollectionItemPlacerGOBase)
Attach()

Item placer is going into attached state either after initialization or after being dormant in game object pool.

(Inherited from DataCollectionItemPlacerGOBase)
AttachItemPlacer()

Perform additional attach prep in derived class.

(Inherited from DataCollectionItemPlacerGOBase)
ChangeItemState(Int32, DataCollectionItemPlacerGOBase+State) (Inherited from DataCollectionItemPlacerGOBase)
CheckAndFixVisibleRange() (Inherited from DataCollectionItemPlacerGOBase)
CheckForEventsToTrigger() (Inherited from DataCollectionItemPlacerGOBase)
Detach()

Item placer is going into detached state either before returning in game object pool or destroy

(Inherited from DataCollectionItemPlacerGOBase)
DetachItemPlacer()

Perform additional detach teardown in derived class.

(Inherited from DataCollectionItemPlacerGOBase)
EndPlacement()

End placement for the requested range of game objects

(Inherited from DataCollectionItemPlacerGOBase)
FindItem(Int32) (Inherited from DataCollectionItemPlacerGOBase)
FindNearestCollectionEvents()

Search through game object hierarchy for the nearest IDataCollectionEvents implementation.

(Inherited from DataCollectionItemPlacerGOBase)
FindOrderedInsertPoint(Transform, Int32) (Inherited from DataCollectionItemPlacerGOBase)
GetFirstVisibleItem()

Get the list index of the first visible item

(Inherited from DataCollectionItemPlacerGOBase)
GetItemCountPerPage()

Get nominal number of items per logical page.

GetMaxVisibleItemCount() (Inherited from DataCollectionItemPlacerGOBase)
GetPageNumber()

Get current page number for first visible item.

(Inherited from DataCollectionItemPlacerGOBase)
GetTotalItemCount()

Get the total number of items in the collection.

(Inherited from DataCollectionItemPlacerGOBase)
GetTotalPageCount()

Get the total number of pages in the collection based on current page size.

(Inherited from DataCollectionItemPlacerGOBase)
IsAtEnd()

Are visible items at the end of list

(Inherited from DataCollectionItemPlacerGOBase)
IsAtStart()

Are visible items at beginning of list

(Inherited from DataCollectionItemPlacerGOBase)
IsVisible(Int32)

Item is currently in the visible range of items

(Inherited from DataCollectionItemPlacerGOBase)
ItemExists(Int32) (Inherited from DataCollectionItemPlacerGOBase)
MoveAbsolute(Int32, Boolean)

Scroll visible data window to the specified first visible item

(Inherited from DataCollectionItemPlacerGOBase)
MoveRelative(Int32, Boolean)

Scroll visible data window by itemCount items forward or backward

(Inherited from DataCollectionItemPlacerGOBase)
MoveToNextItem()

Scroll forward one item if possible.

(Inherited from DataCollectionItemPlacerGOBase)
MoveToPreviousItem()

Scroll back one item if possible.

(Inherited from DataCollectionItemPlacerGOBase)
NotifyCollectionDataChanged(DataChangeType, String, Object)

Notification that the collection being managed by the data consumer for this object has changed.

(Inherited from DataCollectionItemPlacerGOBase)
PageBackward()

Scroll back one page if possible, or to beginning if partial page.

(Inherited from DataCollectionItemPlacerGOBase)
PageForward()

Scroll forward one page if possible, or to end of list if partial page.

(Inherited from DataCollectionItemPlacerGOBase)
PlaceItem(Object, Int32, String, GameObject)

Place a game object into the experience previously requested via IDataConsumer.RequestCollectionItems()

(Inherited from DataCollectionItemPlacerGOBase)
PredictivelyLoadItems() (Inherited from DataCollectionItemPlacerGOBase)
ProcessReceivedItem(Object, Int32, String, GameObject, Boolean)

Place a visible item into the experience

ProcessRemovedItem(Object, Int32, String, GameObject, Boolean)

Process the removal of an item that is no longer in the collection

PurgeAllItems() (Inherited from DataCollectionItemPlacerGOBase)
PurgeAllRemovableGameObjects()

Purge all game objects that have been queued for removal.

(Inherited from DataCollectionItemPlacerGOBase)
PurgeAllVisibleAndRemovableItems() (Inherited from DataCollectionItemPlacerGOBase)
PurgePrefetchedItems() (Inherited from DataCollectionItemPlacerGOBase)
PurgeRemovableGameObjectRange(Int32, Int32)

Purge a range of game objects that have been queued for removal.

(Inherited from DataCollectionItemPlacerGOBase)
QueueGameObjectsForRemoval(Int32, Int32) (Inherited from DataCollectionItemPlacerGOBase)
RemoveItem(Int32) (Inherited from DataCollectionItemPlacerGOBase)
RepositionItems(Int32, Int32) (Inherited from DataCollectionItemPlacerGOBase)
RequestAnyMissingVisibleItems() (Inherited from DataCollectionItemPlacerGOBase)
RequestItems(Int32, Int32) (Inherited from DataCollectionItemPlacerGOBase)
SetDataConsumerCollection(IDataConsumerCollection)

Set the data consumer collection that is providing items for this item placer.

(Inherited from DataCollectionItemPlacerGOBase)
ShouldBeVisible(Int32)

Item is or would be visible if there were enough items to be shown.

(Inherited from DataCollectionItemPlacerGOBase)
StartPlacement()

Start placement for the requested range of game objects.

StashOrReturnItem(DataCollectionItemPlacerGOBase+ItemInfo) (Inherited from DataCollectionItemPlacerGOBase)
UpdateItem(Int32, DataCollectionItemPlacerGOBase+State, String, GameObject) (Inherited from DataCollectionItemPlacerGOBase)

Applies to