io.extendreality.zinnia.unity - npm Package Versions

1.17.1 (2020-05-22)

Bug Fixes

• Extraction: remove Cleared attribute from ValueExtractor.Source (adff3f2)

  The Source property from the ValueExtractor is of a generic type and if the Cleared attribute is used then Malimbe will always weave an auto generated Clear method that attempts to set the property to null and this will cause issues in IL2CPP when attempting to clear non nullable types such as RaycastHit.

  As there is a manual ClearSource method already that sets Source to default then this Cleared attribute can simply be removed.

1.17.0 (2020-05-22)

Features

• Association: determine association by platform, sdk and model (1680f63)

  The PlatformDeviceAssociation component allows the determining of the hardware based on matching patterns of the current platform, the SDK loaded by Unity and the model type.

  As all of these are patterns, then they can be used to search for anything or specific types of setup.

  The LoadedXrDeviceAssociation has now been deprecated as it offers a subset of this new functionality but isn't as powerful.

• Conversion: ability to convert between float and normalized float (b65cd03)

  The FloatToNormalizedFloat allows a float value to be converted into a normalized float (between 0f and 1f) and the NormalizedFloatToFloat allows for a normalized float to be converted to a float value based within the range provided.

  The FloatToBoolean has also had the min/max limit removed so any float value can be used to check to see if it should be within the positive bounds.

• Conversion: option to convert vector2 to signed angle (fd1084d)

  The Vector2ToAngle component now has the option of converting to a signed angle in either degrees or radians.

  This allows an angle range of -180 degrees to 180 degrees instead of 0 to 360 degrees and this will feed in better to the FloatToBoolean when wanting to know if the angle is between a given range as it is possible to do -20/20 as a range whereas it's not possible to do 340/20 as a range.

Bug Fixes

• Extraction: override ClearSource method for generics (6ca9cfb)

  There is an issue with using the Malimbe generated ClearSource method when using it with a generic type property as the actual type may not be a nullable type and the MemberCleared weaved code always tries to set it to null.

  In this regard, it is better to simply override the method and set the property to default. This is not done in Malimbe as providing default as the weaved code is extremely tricky.

1.16.0 (2020-04-21)

Features

• Pointer: allow origin transform of event data to be overriden (74c8d80)

  The Pointer origin was previously always the Transform that the ObjectPointer component was on, but this new field allows an alternative origin to be provided if required.

• Tracking: allow previous position to be valid located surface (6592687)

  The SurfaceLocator would always not consider a valid location if the previous location was the same as the current location. This new option allows that equality check to be ignored.

  Also, the equality threshold is no longer a constant and instead a value that can be changed via the public property.

• Tracking: allow properties to be applied even if they are equal (b636bca)

  The TransformPropertyApplier now has an option to still apply properties even if the properties are equal.

Bug Fixes

• Tracking: calculate properties correctly if dynamic destination (f1191e9)

  This fix will calculate properties correctly if IsTransitionDestinationDynamic is true. Before the fix, it does not honor the ApplyTransformations settings.

  This fix is by Ethan Cheung ethan@fight4dream.com

  Co-authored-by: Ethan Cheung ethan@fight4dream.com

1.15.0 (2020-04-14)

Features

• Cache: provide cache operations for common data types (f1ef2f0)

  The Cache operation allows a data type value to be stored in a cache and then an appropriate event is raised when the value is updated.

  If the value is considered equal then the Unmodified event is emitted. However, if the values are not equal then the Modified event is emitted.

• Extraction: add extractors for SurfaceData and RaycastHit (dcab0ef)

  A collection of extractors that firstly extract the RaycastHit data from a SurfaceData and then a collection of extractors that can extract specific data from the RaycastHit.

  This new collection means the existing SurfaceDataCollisionPointExtractor becomes obsolete as it is too specific for the extractor pattern and can be achieved by first extracting the RaycastHit from the SurfaceData and then extracting the RaycastHit.point from the RaycastHit output.

• Extraction: consolidate all extractors into 1 base class (77e6f97)

  (Nearly) all of the extractors now all inherit from a single ValueExtractor class which contains most of the logic ensuring extractors all have a standard API.

  There are a couple of extractors that have multiple events for extraction and these don't fit into this model yet so have been left out. These are:

  • ObjectDistanceComparatorEventDataExtractor * TransformPropertyApplierEventDataExtractor

  These will be updated in the future to provide individual extrators that can then follow the standard Extractor pattern.

  All Extractors now also implement iProcessable so can all be used with a MomentProcessor.

  All Extractors also invoke a Failed event which is raised when the extractor has failed to extract the value. This is to ensure the PlayAreaDimensionExtractor still has the relevant events required and can fit in the standard Extractor pattern. Plus, having a Failed event is useful to know when an Extractor has failed.

  The TransformPropertyExtractor has been renamed to TransformVector3PropertyExtractor which originally existed within the same file but now it can simply extend the Vector3Extrator but the old extractor had a separate property for storing the result of the extraction called LastExtractedValue. This property is still available but it has been deprecated and the Result field should now be used to get the extracted value.

• Extraction: deprecate Vector2ComponentExtractor (4103c15)

  The Zinnia.Data.Type.Transformation.Conversion.Vector2ToFloat component does the same job as the Vector2ComponentExtractor so there is no need to have both.

Bug Fixes

• Extraction: ensure extraction cannot be mutated if disabled (bf6ceef)

  The main Extract() method should do a check to see if the component is active and enabled and if its not then it should force set the Result to null across all Extractors.

  Also, the RequiresBehaviourState attribute has been added to the Extract methods that allow the data to be passed in via a parameter as they were allowing mutation to the source even when the component was inactive.

  Finally, any extractors that didn't have the Extract methods that allowed a parameter have been updated to include these methods too.

• Extraction: ensure extraction logic order is consistent (4f77a78)

  The TransformPropertyExtractor worked in the opposite way from other extrators where the Extract method does all the work and the DoExtract method just calls the Extract method without any return.

  This has now been updated so it follows this standard logic.

• Extraction: flip extraction logic for local direction (2cb589c)

  The TransformDirectionExtractor had the UseLocal logic the wrong way round. It was returning the global Vector3.<direction> if UseLocal was true and returning the direction of the Source if UseLocal was false.

  This doesn't make sense because Vector3.<direction> is the global direction whereas the direction of the Source is technically local to the Source.

  This is also technically a change that can cause breaks because the logic is now flipped. But rather than do a clever deprecation or anything, it's probably just better to handle complaints as its just fixed by checking (or unchecking) the UseLocal property.

• structure: apply coding conventions (008723a)

  The coding conventions in regards to namespace order has now been applied so the default VisualStudio namespace order is applied to all scripts.

  Any missing code comments have also been added to any non-test related script.

Code Refactoring

• Extraction: simplify the InvokeResult method (441b7c9)

  The ValueExtractor now has a way of dealing with the differences between the TResultElement and TEventElement when the InvokeResult method is called by piping the actual logic into a generic InvokeEvent method meaning each of the concrete classes don't have to repeat the logic.

1.14.1 (2020-04-01)

Bug Fixes

• Action: remove unchanged event from being chained in sources (d17a0c5)

  Having the ValueUnchanged event in the Sources chain does not make sense as it causes the any concept of the Sources to fail because the logic goes:

  Has SourceA changed? no, then don't call Target.Receive but SourceA is unchanged so call Target.Receive Has SourceB changed? no, then don't call Target.Receive but SourceB is unchanged so call Target.Receive

  The above scenario would mean Target is still false, however:

  Has SourceA changed? Yes, then call Target.Receive(true) SourceA is changed so the second receive won't be called Has SourceB changed? No, then don't call Target.Receive SourceB is unchanged so call Target.Receive(false)

  Now Target has gone from true to false causing it to reset its own state.

  Really, the Sources should only be used for actual change proxying and not try to do an any on unchanged values.

1.14.0 (2020-03-04)

Features

• Tracking: link supplement headset cameras to an alias association (364023b)

  The LinkedAliasAssociationCollection now has an additional parameter that can store a list of other cameras that may have relevance to the tracked alias.

  This aids when a HMD is using multiple cameras per eye for example.

• Tracking: provide haptic process references for controllers (e96e439)

  The LinkedAliasAssociationCollection now has a reference for the left and right controller haptic processes so any CameraRig configuration can provide the default haptic process required for the appropriate SDK.

1.13.0 (2020-03-02)

Features

• Action: add ValueUnchanged event to Action (8c704be)

  A ValueUnchanged event has been added to compliment the ValueChanged Action. The new ValueUnchanged event will raise when the Action receives the same value as it is currently holding.

  This event can then be used to call EmitActivationState to re-raise the relevant events.

• Action: add Vector3 action (ff534bf)

  The Vector3 Action raises a Vector3 value in the same way as the Vector2 Action.

• Extraction: add Unity Time component extractor (85941f8)

  The TimeComponentExtractor will extract a specified value from the UnityEngine.Time object and emit the result.

• Proxy: add event proxies for Vector2 and Vector3 events (af49ebd)

  The Vector2 and Vector3 events can now be proxied via the new EventProxyEmitters.

1.12.0 (2020-02-24)

Features

• Data: add KeyNotFound event to GameObjectRelations (b75f607)

  The KeyNotFound event is raised whenever the GetValue method on the GameObjectRelations component is called but no key can be matched because either the key is not in the dictionary or the index given is out of bounds of the collection.

Bug Fixes

• Tracking: cache tracker source when OnEnable (bc6cd5f)

  This fix will cache velocity tracker for this component to work when the ProxySource is set up in editor time.

1.11.0 (2019-12-31)

Features

• Action: add method for action to receive its own default value (4d7a4ba)

  The new ReceiveDefaultValue method is a shortcut for the Receive method but it simply makes the Action receive its own default value.

  This can be used to programmatically get an Action to call its own deactivation event if the Action is already activated without needing to know the type of the concrete action. This is useful when dealing with Actions in their generic abstract form but wanting them to emit their deactivated state for whatever reason, such as a linked GameObject becoming disabled.

1.10.4 (2019-12-21)

Miscellaneous Chores

• deps: bump io.extendreality.malimbe from 9.6.4 to 9.6.5 (2a8ba92)

  Bumps io.extendreality.malimbe from 9.6.4 to 9.6.5. - Release notes - Changelog - Commits

  Signed-off-by: dependabot-preview[bot] support@dependabot.com