Tanoda
Leap.Unity.GraphicalRenderer.LeapGraphicGroup Class Reference
Inheritance diagram for Leap.Unity.GraphicalRenderer.LeapGraphicGroup:
Leap.Unity.GraphicalRenderer.ILeapInternalGraphicGroup

Classes

class  FeatureList
 
class  RenderingMethodReference
 

Public Member Functions

bool TryAddGraphic (LeapGraphic graphic)
 Tries to add the given graphic to this group. This can safely be called during runtime or edit time. This method can fail under the following conditions: More...
 
void RefreshGraphicAnchors ()
 
bool TryRemoveGraphic (LeapGraphic graphic)
 Tries to remove the given graphic from this group. This can safely be called during runtime or edit time. This method can fail under the following conditions: More...
 
bool GetSupportedFeatures< T > (List< T > features)
 Fills the argument list with all of the currently supported features of type T. Returns true if there are any supported features, and returns false if there are no supported features. More...
 
void UpdateRenderer ()
 
void RebuildFeatureData ()
 
void RebuildFeatureSupportInfo ()
 
void OnEnable ()
 Specifically called during the OnEnable callback during RUNTIME ONLY More...
 
void OnDisable ()
 Specifically called during the OnDisable callback during RUNTIME ONLY More...
 
void OnBeforeSerialize ()
 
void OnAfterDeserialize ()
 

Properties

string name [get]
 
LeapGraphicRenderer renderer [get]
 Gets the renderer this group is attached to. More...
 
LeapRenderingMethod renderingMethod [get]
 Gets the rendering method used for this group. This can only be changed at edit time using either the inspector interface, or the editor method ChangeRenderingMethod. More...
 
IList< LeapGraphicFeatureBasefeatures [get]
 Returns the list of features attached to this group. This can only be changed at edit time using either the inspector interface, or the editor methods AddFeature and RemoveFeature. More...
 
List< LeapGraphicgraphics [get]
 Returns the list of graphics attached to this group. This getter returns a regular mutable list for simplicity and efficiency, but the user is still not allowed to mutate this list in any way. More...
 
int toBeAttachedCount [get]
 Returns the total number of graphics that will be part of this group after the next update cycle. Since attachments are delayed, this number can be larger than graphics.Count. More...
 
List< SupportInfosupportInfo [get]
 Maps 1-to-1 with the feature list, where each element represents the support that feature currently has. More...
 
bool addRemoveSupported [get]
 Returns whether or not add/remove operations are supported at runtime by this group. If this returns false, TryAddGraphic and TryRemoveGraphic will always fail at runtime. More...
 
- Properties inherited from Leap.Unity.GraphicalRenderer.ILeapInternalGraphicGroup
LeapGraphicRenderer renderer [set]
 

Detailed Description

Definition at line 24 of file LeapGraphicGroupEditorApi.cs.

Member Function Documentation

◆ GetSupportedFeatures< T >()

bool Leap.Unity.GraphicalRenderer.LeapGraphicGroup.GetSupportedFeatures< T > ( List< T >  features)

Fills the argument list with all of the currently supported features of type T. Returns true if there are any supported features, and returns false if there are no supported features.

Type Constraints
T :LeapGraphicFeatureBase 

Definition at line 313 of file LeapGraphicGroup.cs.

◆ OnAfterDeserialize()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.OnAfterDeserialize ( )

Definition at line 581 of file LeapGraphicGroup.cs.

◆ OnBeforeSerialize()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.OnBeforeSerialize ( )

Definition at line 579 of file LeapGraphicGroup.cs.

◆ OnDisable()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.OnDisable ( )

Specifically called during the OnDisable callback during RUNTIME ONLY

Definition at line 455 of file LeapGraphicGroup.cs.

◆ OnEnable()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.OnEnable ( )

Specifically called during the OnEnable callback during RUNTIME ONLY

Definition at line 439 of file LeapGraphicGroup.cs.

◆ RebuildFeatureData()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.RebuildFeatureData ( )

Definition at line 341 of file LeapGraphicGroup.cs.

◆ RebuildFeatureSupportInfo()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.RebuildFeatureSupportInfo ( )

Definition at line 376 of file LeapGraphicGroup.cs.

◆ RefreshGraphicAnchors()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.RefreshGraphicAnchors ( )

Definition at line 232 of file LeapGraphicGroup.cs.

◆ TryAddGraphic()

bool Leap.Unity.GraphicalRenderer.LeapGraphicGroup.TryAddGraphic ( LeapGraphic  graphic)

Tries to add the given graphic to this group. This can safely be called during runtime or edit time. This method can fail under the following conditions:

  • The graphic is already attached to this group.
  • The graphic is already attached to a different group.
  • It is runtime and add/remove is not supported by this group.

At runtime the actual attachment is delayed until LateUpdate for efficiency reasons. Expect that even if this method returns true that the graphic will not actually be attached until the end of LateUpdate.

Definition at line 160 of file LeapGraphicGroup.cs.

◆ TryRemoveGraphic()

bool Leap.Unity.GraphicalRenderer.LeapGraphicGroup.TryRemoveGraphic ( LeapGraphic  graphic)

Tries to remove the given graphic from this group. This can safely be called during runtime or edit time. This method can fail under the following conditions:

  • The graphic is not attached to this group.
  • It is runtime and add/remove is not supported by this group.

At runtime the actual detachment is delayed until LateUpdate for efficiency reasons. Expect that even if this method returns true that the graphic will not actually be detached until the end of LateUpdate.

Definition at line 250 of file LeapGraphicGroup.cs.

◆ UpdateRenderer()

void Leap.Unity.GraphicalRenderer.LeapGraphicGroup.UpdateRenderer ( )

Definition at line 326 of file LeapGraphicGroup.cs.

Property Documentation

◆ addRemoveSupported

bool Leap.Unity.GraphicalRenderer.LeapGraphicGroup.addRemoveSupported
get

Returns whether or not add/remove operations are supported at runtime by this group. If this returns false, TryAddGraphic and TryRemoveGraphic will always fail at runtime.

Definition at line 142 of file LeapGraphicGroup.cs.

◆ features

IList<LeapGraphicFeatureBase> Leap.Unity.GraphicalRenderer.LeapGraphicGroup.features
get

Returns the list of features attached to this group. This can only be changed at edit time using either the inspector interface, or the editor methods AddFeature and RemoveFeature.

Definition at line 95 of file LeapGraphicGroup.cs.

◆ graphics

List<LeapGraphic> Leap.Unity.GraphicalRenderer.LeapGraphicGroup.graphics
get

Returns the list of graphics attached to this group. This getter returns a regular mutable list for simplicity and efficiency, but the user is still not allowed to mutate this list in any way.

Definition at line 107 of file LeapGraphicGroup.cs.

◆ name

string Leap.Unity.GraphicalRenderer.LeapGraphicGroup.name
get

Definition at line 55 of file LeapGraphicGroup.cs.

◆ renderer

LeapGraphicRenderer Leap.Unity.GraphicalRenderer.LeapGraphicGroup.renderer
get

Gets the renderer this group is attached to.

Implements Leap.Unity.GraphicalRenderer.ILeapInternalGraphicGroup.

Definition at line 64 of file LeapGraphicGroup.cs.

◆ renderingMethod

LeapRenderingMethod Leap.Unity.GraphicalRenderer.LeapGraphicGroup.renderingMethod
get

Gets the rendering method used for this group. This can only be changed at edit time using either the inspector interface, or the editor method ChangeRenderingMethod.

Definition at line 84 of file LeapGraphicGroup.cs.

◆ supportInfo

List<SupportInfo> Leap.Unity.GraphicalRenderer.LeapGraphicGroup.supportInfo
get

Maps 1-to-1 with the feature list, where each element represents the support that feature currently has.

Definition at line 129 of file LeapGraphicGroup.cs.

◆ toBeAttachedCount

int Leap.Unity.GraphicalRenderer.LeapGraphicGroup.toBeAttachedCount
get

Returns the total number of graphics that will be part of this group after the next update cycle. Since attachments are delayed, this number can be larger than graphics.Count.

Definition at line 119 of file LeapGraphicGroup.cs.


The documentation for this class was generated from the following files: