diff --git a/Packages/systems.speckle.speckle-unity/Editor/Wrappers/Selection/StreamSelectionEditor.cs b/Packages/systems.speckle.speckle-unity/Editor/Wrappers/Selection/StreamSelectionEditor.cs index 971c987..378bb8b 100644 --- a/Packages/systems.speckle.speckle-unity/Editor/Wrappers/Selection/StreamSelectionEditor.cs +++ b/Packages/systems.speckle.speckle-unity/Editor/Wrappers/Selection/StreamSelectionEditor.cs @@ -46,8 +46,8 @@ public StreamSelectionDrawer() ("Description", s => s.description), ("Is Public", s => s.isPublic.ToString()), ("Role", s => s.role), - ("Created at", s => s.createdAt), - ("Updated at", s => s.updatedAt), + ("Created at", s => s.createdAt.ToString()), + ("Updated at", s => s.updatedAt.ToString()), }; } } @@ -84,7 +84,7 @@ public CommitSelectionDrawer() { ("Commit Id", s => s.id), ("Author Name", s => s.authorName), - ("Created At", s => s.createdAt), + ("Created At", s => s.createdAt.ToString()), ("Source Application", s => s.sourceApplication), ("Reference Object Id", s => s.referencedObject), }; diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Converter/Unity/ConverterUnity.Geometry.cs b/Packages/systems.speckle.speckle-unity/Runtime/Converter/Unity/ConverterUnity.Geometry.cs index 155097a..19c4a9a 100644 --- a/Packages/systems.speckle.speckle-unity/Runtime/Converter/Unity/ConverterUnity.Geometry.cs +++ b/Packages/systems.speckle.speckle-unity/Runtime/Converter/Unity/ConverterUnity.Geometry.cs @@ -354,4 +354,4 @@ protected static void ApplyMatrixToTransform(Transform transform, Matrix4x4 m) } } -} \ No newline at end of file +} diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.dll b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.dll index 0e82387..a5773a7 100644 Binary files a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.dll and b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.dll differ diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.pdb b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.pdb index 7a82b06..8d2ed53 100644 Binary files a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.pdb and b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.pdb differ diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.xml b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.xml index 8361b01..7c85305 100644 --- a/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.xml +++ b/Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.xml @@ -6,19 +6,19 @@ - Base class for GraphQL API exceptions + Base class for GraphQL API exceptions - Represents a "FORBIDDEN" on "UNAUTHORIZED" GraphQL error as an exception. - https://www.apollographql.com/docs/apollo-server/v2/data/errors/#unauthenticated - https://www.apollographql.com/docs/apollo-server/v2/data/errors/#forbidden + Represents a "FORBIDDEN" on "UNAUTHORIZED" GraphQL error as an exception. + https://www.apollographql.com/docs/apollo-server/v2/data/errors/#unauthenticated + https://www.apollographql.com/docs/apollo-server/v2/data/errors/#forbidden - Gets the activity of a stream + Gets the activity of a stream Id of the stream to get the activity from Only show activity after this DateTime @@ -30,7 +30,7 @@ - Gets the activity of a stream + Gets the activity of a stream Id of the stream to get the activity from @@ -44,7 +44,7 @@ - Get branches from a given stream + Get branches from a given stream Id of the stream to get the branches from Max number of branches to retrieve @@ -53,7 +53,7 @@ - Get branches from a given stream + Get branches from a given stream Id of the stream to get the branches from @@ -64,21 +64,21 @@ - Creates a branch on a stream. + Creates a branch on a stream. The stream's id. - Creates a branch on a stream. + Creates a branch on a stream. The branch id. - Gets a given branch from a stream. + Gets a given branch from a stream. Id of the stream to get the branch from Name of the branch to get @@ -86,7 +86,7 @@ - Gets a given branch from a stream. + Gets a given branch from a stream. Id of the stream to get the branch from @@ -95,35 +95,35 @@ - Updates a branch. + Updates a branch. The stream's id. - Updates a branch. + Updates a branch. The stream's id. - Deletes a stream. + Deletes a stream. - Deletes a stream. + Deletes a stream. - Gets the comments on a Stream + Gets the comments on a Stream Id of the stream to get the comments from The number of comments to get @@ -132,7 +132,7 @@ - Gets the comments on a Stream + Gets the comments on a Stream Id of the stream to get the comments from @@ -143,7 +143,7 @@ - Gets the screenshot of a Comment + Gets the screenshot of a Comment Id of the comment Id of the stream to get the comment from @@ -151,7 +151,7 @@ - Gets the screenshot of a Comment + Gets the screenshot of a Comment Id of the comment @@ -161,7 +161,7 @@ - Gets a given commit from a stream. + Gets a given commit from a stream. Id of the stream to get the commit from Id of the commit to get @@ -169,7 +169,7 @@ - Gets a given commit from a stream. + Gets a given commit from a stream. Id of the stream to get the commit from @@ -178,7 +178,7 @@ - Gets the latest commits from a stream + Gets the latest commits from a stream Id of the stream to get the commits from Max number of commits to get @@ -186,7 +186,7 @@ - Gets the latest commits from a stream + Gets the latest commits from a stream Id of the stream to get the commits from @@ -196,58 +196,58 @@ - Creates a commit on a branch. + Creates a commit on a branch. The commit id. - + - Updates a commit. + Updates a commit. The stream's id. - Updates a commit. + Updates a commit. The stream's id. - Deletes a commit. + Deletes a commit. - Deletes a commit. + Deletes a commit. - Sends a commitReceived mutation, affirming a commit has been received. + Sends a commitReceived mutation, affirming a commit has been received. Used for read receipts - + - Gets a given object from a stream. + Gets a given object from a stream. Id of the stream to get the object from Id of the object to get @@ -255,7 +255,7 @@ - Gets a given object from a stream. + Gets a given object from a stream. Id of the stream to get the object from @@ -264,7 +264,7 @@ - Gets a given object from a stream. + Gets a given object from a stream. @@ -272,7 +272,7 @@ - Gets a given object from a stream. + Gets a given object from a stream. @@ -280,17 +280,18 @@ - - Gets the version of the current server. Useful for guarding against unsupported api calls on newer or older servers. - - [Optional] defaults to an empty cancellation token - object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995") - + + Gets the version of the current server. Useful for guarding against unsupported api calls on newer or older servers. + + [Optional] defaults to an empty cancellation token + object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995") + + - Gets a stream by id including basic branch info (id, name, description, and total commit count). - For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. + Gets a stream by id including basic branch info (id, name, description, and total commit count). + For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. Id of the stream to get Max number of branches to retrieve @@ -298,8 +299,8 @@ - Gets a stream by id including basic branch info (id, name, description, and total commit count). - For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. + Gets a stream by id including basic branch info (id, name, description, and total commit count). + For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. Id of the stream to get Max number of branches to retrieve @@ -307,28 +308,28 @@ - Gets all streams for the current user + Gets all streams for the current user Max number of streams to return - Gets all streams for the current user + Gets all streams for the current user Max number of streams to return - Gets all favorite streams for the current user + Gets all favorite streams for the current user Max number of streams to return - Searches the user's streams by name, description, and ID + Searches the user's streams by name, description, and ID String query to search for Max number of streams to return @@ -336,7 +337,7 @@ - Searches the user's streams by name, description, and ID + Searches the user's streams by name, description, and ID String query to search for Max number of streams to return @@ -344,28 +345,28 @@ - Creates a stream. + Creates a stream. The stream's id. - Creates a stream. + Creates a stream. The stream's id. - Updates a stream. + Updates a stream. Note: the id field needs to be a valid stream id. The stream's id. - Updates a stream. + Updates a stream. Note: the id field needs to be a valid stream id. @@ -373,14 +374,14 @@ - Deletes a stream. + Deletes a stream. Id of the stream to be deleted - Deletes a stream. + Deletes a stream. Id of the stream to be deleted @@ -388,14 +389,14 @@ - Grants permissions to a user on a given stream. + Grants permissions to a user on a given stream. - Grants permissions to a user on a given stream. + Grants permissions to a user on a given stream. @@ -403,14 +404,14 @@ - Revokes permissions of a user on a given stream. + Revokes permissions of a user on a given stream. - Revokes permissions of a user on a given stream. + Revokes permissions of a user on a given stream. @@ -418,7 +419,7 @@ - Updates permissions for a user on a given stream. + Updates permissions for a user on a given stream. includes the streamId, the userId of the user to update, and the user's new role @@ -427,16 +428,16 @@ - Gets the pending collaborators of a stream by id. - Requires the user to be an owner of the stream. + Gets the pending collaborators of a stream by id. + Requires the user to be an owner of the stream. Id of the stream to get - Gets the pending collaborators of a stream by id. - Requires the user to be an owner of the stream. + Gets the pending collaborators of a stream by id. + Requires the user to be an owner of the stream. Id of the stream to get Max number of branches to retrieve @@ -444,14 +445,14 @@ - Sends an email invite to join a stream and assigns them a collaborator role. + Sends an email invite to join a stream and assigns them a collaborator role. - Sends an email invite to join a stream and assigns them a collaborator role. + Sends an email invite to join a stream and assigns them a collaborator role. @@ -459,7 +460,7 @@ - Cancels an invite to join a stream. + Cancels an invite to join a stream. Id of the stream Id of the invite to cancel @@ -468,7 +469,7 @@ - Checks if Speckle Server version is at least v2.6.4 meaning stream invites are supported. + Checks if Speckle Server version is at least v2.6.4 meaning stream invites are supported. true if invites are supported @@ -476,7 +477,7 @@ - Accept or decline a stream invite. + Accept or decline a stream invite. @@ -487,13 +488,13 @@ - Gets the currently active user profile. + Gets the currently active user profile. - Gets the currently active user profile. + Gets the currently active user profile. @@ -501,14 +502,14 @@ - Get another user's profile by its user id. + Get another user's profile by its user id. Id of the user you are looking for - Get another user's profile by its user id. + Get another user's profile by its user id. Id of the user you are looking for @@ -517,7 +518,7 @@ - Searches for a user on the server. + Searches for a user on the server. String to search for. Must be at least 3 characters Max number of users to return @@ -525,7 +526,7 @@ - Searches for a user on the server. + Searches for a user on the server. String to search for. Must be at least 3 characters Max number of users to return @@ -533,156 +534,146 @@ - Subscribe to events of branch created for a stream + Subscribe to events of branch created for a stream - Subscribe to events of branch updated for a stream + Subscribe to events of branch updated for a stream - Subscribe to events of branch deleted for a stream + Subscribe to events of branch deleted for a stream - Subscribe to events of commit created for a stream + Subscribe to events of commit created for a stream - Subscribe to events of commit updated for a stream + Subscribe to events of commit updated for a stream - Subscribe to events of commit updated for a stream + Subscribe to events of commit updated for a stream - Subscribe to events of streams added for the current user + Subscribe to events of streams added for the current user - Subscribe to events of streams updated for a specific streamId + Subscribe to events of streams updated for a specific streamId streamId - Subscribe to events of streams removed for the current user + Subscribe to events of streams removed for the current user - - Subscribe to new comment events - + + Subscribe to new comment events + + - Set only in the case that you've requested this through - . + Set only in the case that you've requested this through . - Set only in the case that you've requested this through - . + Set only in the case that you've requested this through . - Set only in the case that you've requested this through - + Set only in the case that you've requested this through - GraphQL DTO model for active user data + GraphQL DTO model for active user data - User profile of the active user. + User profile of the active user. - GraphQL DTO model for limited user data. Mostly referring to other user's profile. + GraphQL DTO model for limited user data. Mostly referring to other user's profile. - The limited user profile of another (non active user) + The limited user profile of another (non active user) - OS - NOTE: do not edit order and only append new items as they are serialized to ints + OS + NOTE: do not edit order and only append new items as they are serialized to ints - Architecture - NOTE: do not edit order and only append new items as they are serialized to ints + Architecture + NOTE: do not edit order and only append new items as they are serialized to ints - Envirenment Variable that allows to overwrite the - /// - + Envirenment Variable that allows to overwrite the + /// - Returns the correct location of the Speckle installation folder. Usually this would be the user's %appdata%/Speckle - folder, unless the install was made for all users. + Returns the correct location of the Speckle installation folder. Usually this would be the user's %appdata%/Speckle folder, unless the install was made for all users. The location of the Speckle installation folder - Returns the correct location of the Speckle folder for the current user. Usually this would be the user's - %appdata%/Speckle folder. + Returns the correct location of the Speckle folder for the current user. Usually this would be the user's %appdata%/Speckle folder. The location of the Speckle installation folder - Returns the correct location of the AppData folder where Speckle is installed. Usually this would be the user's - %appdata% folder, unless the install was made for all users. - This folder contains Kits and othe data that can be shared among users of the same machine. + Returns the correct location of the AppData folder where Speckle is installed. Usually this would be the user's %appdata% folder, unless the install was made for all users. + This folder contains Kits and othe data that can be shared among users of the same machine. The location of the AppData folder where Speckle is installed - Returns the location of the User Application Data folder for the current roaming user, which contains user specific - data such as accounts and cache. + Returns the location of the User Application Data folder for the current roaming user, which contains user specific data such as accounts and cache. The location of the user's `%appdata%` folder. - Helper method to Receive from a Speckle Server. + Helper method to Receive from a Speckle Server. - - Stream URL or Id to receive from. If the URL contains branchName, commitId or objectId those will - be used, otherwise the latest commit from main will be received. - + Stream URL or Id to receive from. If the URL contains branchName, commitId or objectId those will be used, otherwise the latest commit from main will be received. Account to use. If not provided the default account will be used. Action invoked on progress iterations. Action invoked on internal errors. @@ -691,38 +682,44 @@ - Helper method to Send to a Speckle Server. + Helper method to Send to a Speckle Server. - - Stream URL or Id to send to. If the URL contains branchName, commitId or objectId those will be - used, otherwise the latest commit from main will be received. - + Stream URL or Id to send to. If the URL contains branchName, commitId or objectId those will be used, otherwise the latest commit from main will be received. Data to send Account to use. If not provided the default account will be used. - - Toggle for the default cache. If set to false, it will only send to the provided - transports. - + Toggle for the default cache. If set to false, it will only send to the provided transports. Action invoked on progress iterations. Action invoked on internal errors. - + + + + The connector slug eg. revit, rhino, etc + + + + + value to fallback to if the given is + + + Formats the given difference between the current system time and the provided + into a human readable string - The connector slug eg. revit, rhino, etc - + + A Human readable string - Convenience method to instantiate an instance of the default object serializer and settings pre-populated with it. + Convenience method to instantiate an instance of the default object serializer and settings pre-populated with it. - Receives an object from a transport. + Receives an object from a transport. The transport to receive from. @@ -734,13 +731,10 @@ - Receives an object from a transport. + Receives an object from a transport. - - A cancellation token that can be used by other objects or threads to send notice of - cancellation. - + A cancellation token that can be used by other objects or threads to send notice of cancellation. The transport to receive from. Leave null to use the default cache. Action invoked on progress iterations. @@ -750,54 +744,37 @@ - Sends an object via the provided transports. Defaults to the local cache. + Sends an object via the provided transports. Defaults to the local cache. The object you want to send. Where you want to send them. - - Toggle for the default cache. If set to false, it will only send to the provided - transports. - + Toggle for the default cache. If set to false, it will only send to the provided transports. Action that gets triggered on every progress tick (keeps track of all transports). Use this to capture and handle any errors from within the transports. The id (hash) of the object. - Sends an object via the provided transports. Defaults to the local cache. + Sends an object via the provided transports. Defaults to the local cache. The object you want to send. - - A cancellation token that can be used by other objects or threads to send notice of - cancellation. - + A cancellation token that can be used by other objects or threads to send notice of cancellation. Where you want to send them. - - Toggle for the default cache. If set to false, it will only send to the provided - transports. - + Toggle for the default cache. If set to false, it will only send to the provided transports. Action that gets triggered on every progress tick (keeps track of all transports). Use this to capture and handle any errors from within the transports. The id (hash) of the object. - Serializes a given object. Note: if you want to save and persist an object to a Speckle Transport or Server, please - use any of the "Send" methods. See - - . + Serializes a given object. Note: if you want to save and persist an object to a Speckle Transport or Server, please use any of the "Send" methods. See . A json string representation of the object. - Serializes a given object. Note: if you want to save and persist an object to Speckle Transport or Server, please use - any of the "Send" methods. See - - . + Serializes a given object. Note: if you want to save and persist an object to Speckle Transport or Server, please use any of the "Send" methods. See . Propagates notification that operations should be canceled. @@ -805,38 +782,28 @@ - Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" - methods. + Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" methods. - Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" - methods. + Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" methods. - Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any - of the - - . + Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any of the . The json string representation of a speckle object that you want to deserialise. - Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any - of the - - . + Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any of the . The json string representation of a speckle object that you want to deserialise. Propagates notification that operations should be canceled. @@ -844,35 +811,33 @@ - Deserializes a list of objects into an array. Note: if you want to pull an object from speckle (either local or - remote), please use any of the "Receive" methods. + Deserializes a list of objects into an array. Note: if you want to pull an object from speckle (either local or remote), please use any of the "Receive" methods. - Deserializes a dictionary object. Note: if you want to pull an object from speckle (either local or remote), please - use any of the "Receive" methods. + Deserializes a dictionary object. Note: if you want to pull an object from speckle (either local or remote), please use any of the "Receive" methods. - Manage accounts locally for desktop applications. + Manage accounts locally for desktop applications. - Gets the basic information about a server. + Gets the basic information about a server. Server URL - Gets basic user information given a token and a server. + Gets basic user information given a token and a server. Server URL @@ -880,7 +845,7 @@ - Gets basic user and server information given a token and a server. + Gets basic user and server information given a token and a server. Server URL @@ -888,75 +853,70 @@ - The Default Server URL for authentication, can be overridden by placing a file with the alternatrive url in the - Speckle folder or with an ENV_VAR + The Default Server URL for authentication, can be overridden by placing a file with the alternatrive url in the Speckle folder or with an ENV_VAR - Gets all the accounts for a given server. + Gets all the accounts for a given server. - Gets this environment's default account if any. If there is no default, the first found will be returned and set as - default. + Gets this environment's default account if any. If there is no default, the first found will be returned and set as default. The default account or null. - Gets all the accounts present in this environment. + Gets all the accounts present in this environment. - Gets the local accounts - These are accounts not handled by Manager and are stored in json format in a local directory + Gets the local accounts + These are accounts not handled by Manager and are stored in json format in a local directory - Refetches user and server info for each account + Refetches user and server info for each account - Removes an account + Removes an account ID of the account to remove - Changes the default account + Changes the default account - Adds an account by propting the user to log in via a web flow + Adds an account by propting the user to log in via a web flow Server to use to add the account, if not provied the default Server will be used - Creates a StreamWrapper from a stream url or a stream id + Creates a StreamWrapper from a stream url or a stream id - - Stream Url eg: http://speckle.server/streams/8fecc9aa6d/commits/76a23d7179 or stream ID - eg: 8fecc9aa6d - + Stream Url eg: http://speckle.server/streams/8fecc9aa6d/commits/76a23d7179 or stream ID eg: 8fecc9aa6d - Creates a StreamWrapper by streamId, userId and serverUrl + Creates a StreamWrapper by streamId, userId and serverUrl @@ -964,375 +924,391 @@ - Determines if the current stream wrapper contains a valid stream. + Determines if the current stream wrapper contains a valid stream. - Gets a valid account for this stream wrapper. - - Note: this method ensures that the stream exists and/or that the user has an account which has access to that - stream. If used in a sync manner, make sure it's not blocking. - + Gets a valid account for this stream wrapper. + Note: this method ensures that the stream exists and/or that the user has an account which has access to that stream. If used in a sync manner, make sure it's not blocking. - - Throws exception if account fetching failed. This could be due to non-existent account or - stream. - + Throws exception if account fetching failed. This could be due to non-existent account or stream. The valid account object for this stream. - Policy for retrying failing Http requests + Policy for retrying failing Http requests - Policy for retrying failing Http requests + Policy for retrying failing Http requests - Checks if the user has a valid internet connection by first pinging cloudfare (fast) - and then trying get from the default Speckle server (slower) - Each check is retried 3 times + Checks if the user has a valid internet connection by first pinging cloudfare (fast) + and then trying get from the default Speckle server (slower) + Each check is retried 3 times True if the user is connected to the internet, false otherwise. - Pings a specific url to verify it's accessible. Retries 3 times. + Pings a specific url to verify it's accessible. Retries 3 times. The hostname or address to ping. True if the the status code is 200, false otherwise. - Pings and tries gettign data from a specific address to verify it's online. Retries 3 times. + Pings and tries gettign data from a specific address to verify it's online. Retries 3 times. The address to use True if the the status code is successful, false otherwise. - Helper class dedicated for Speckle specific Path operations. + Helper class dedicated for Speckle specific Path operations. - Get the installation path. + Get the installation path. - Get the path where the Speckle applications should be installed + Get the path where the Speckle applications should be installed - Get the folder where the user's Speckle data should be stored. + Get the folder where the user's Speckle data should be stored. - Get the folder where the Speckle kits should be stored. + Get the folder where the Speckle kits should be stored. - - + + + - Get the folder where the Speckle accounts data should be stored. + Get the folder where the Speckle accounts data should be stored. - Override the global Speckle application name. + Override the global Speckle application name. - Override the global Speckle application data path. + Override the global Speckle application data path. - Override the global Blob storage folder name. + Override the global Blob storage folder name. - Override the global Kits folder name. + Override the global Kits folder name. - Override the global Accounts folder name. + Override the global Accounts folder name. - - + + + - Get the platform specific user configuration folder path. + Get the platform specific user configuration folder path. - Get the folder where the user's Speckle blobs should be stored. + Get the folder where the user's Speckle blobs should be stored. - Get the folder where the Speckle logs should be stored. + Get the folder where the Speckle logs should be stored. Name of the application using this SDK ie.: "Rhino" Public version slug of the application using this SDK ie.: "2023" - Returns the versioned app name given a specific version + Returns the versioned app name given a specific version - List of Host Applications - their slugs should match our ghost tags and ci/cd slugs + List of Host Applications - their slugs should match our ghost tags and ci/cd slugs - Gets a HostApplication form a string. It could be the versioned name or a string coming from a process running. + Gets a HostApplication form a string. It could be the versioned name or a string coming from a process running. String with the name of the app - Used to indicate which is the main input parameter of the schema builder component. Schema info will be attached to - this object. + Used to indicate which is the main input parameter of the schema builder component. Schema info will be attached to this object. - Used to ignore properties from expand objects etc + Used to ignore properties from expand objects etc + + + + + Exception thrown when an fails to load/initialise + + + Does NOT inherit from , because this usage of this exception is not dependent on Speckle Data (user data) + Ideally, this exception should contain a meaningful message, and a reference to the + + + + + A reference to the that failed to perform + + + + + Exception thrown when conversion of an object fails + + + Ideally this exception contains a meaningful message, and reference to the object that failed to be converted. + This exception can be used for both ToSpeckle and ToNative conversion + + + + + Exception thrown when an object was desirably skipped - Keeps track of the conversion process + Keeps track of the conversion process - Decides what to do when an element being received already exists + Decides what to do when an element being received already exists - Converts a native object to a Speckle one + Converts a native object to a Speckle one Native object to convert - Converts a list of objects to Speckle. + Converts a list of objects to Speckle. - Checks if it can convert a native object to a Speckle one + Checks if it can convert a native object to a Speckle one Native object to convert - Converts a Speckle object to a native one + Converts a Speckle object to a native one Speckle object to convert - Converts a list of Speckle objects to a native ones. + Converts a list of Speckle objects to a native ones. - Checks if it can convert a Speckle object to a native one + Checks if it can convert a Speckle object to a native one Speckle object to convert - Returns a list of applications serviced by this converter + Returns a list of applications serviced by this converter - Sets the application document that the converter is targeting + Sets the application document that the converter is targeting The current application document - Some converters need to know which other objects are being converted, in order to sort relationships between them - (ie, Revit). Use this method to set them. + Some converters need to know which other objects are being converted, in order to sort relationships between them (ie, Revit). Use this method to set them. - Some converters need to know which objects have been converted before in order to update them (ie, Revit). Use this - method to set them. + Some converters need to know which objects have been converted before in order to update them (ie, Revit). Use this method to set them. - Some converters need to be able to receive some settings to modify their internal behaviour (i.e. Rhino's Brep - Meshing options). Use this method to set them. + Some converters need to be able to receive some settings to modify their internal behaviour (i.e. Rhino's Brep Meshing options). Use this method to set them. The object representing the settings for your converter. - Receive modes indicate what to do and not do when receiving objects + Receive modes indicate what to do and not do when receiving objects - Attemts updating previously received objects by ID, deletes previously received objects that do not exist anymore and - creates new ones + Attemts updating previously received objects by ID, deletes previously received objects that do not exist anymore and creates new ones - Always creates new objects + Always creates new objects - Ignores updating previously received objects and does not attempt updating or deleting them, creates new objects + Ignores updating previously received objects and does not attempt updating or deleting them, creates new objects - Defines the basic interface for creating a "Speckle Kit" + Defines the basic interface for creating a "Speckle Kit" - Gets all the object types (the object model) provided by this kit. + Gets all the object types (the object model) provided by this kit. - Gets all available converters for this Kit. + Gets all available converters for this Kit. - Gets this Kit's description. + Gets this Kit's description. - Gets this Kit's name. + Gets this Kit's name. - Gets this Kit's author. + Gets this Kit's author. - Gets the website (or email) to contact the Kit's author. + Gets the website (or email) to contact the Kit's author. - Tries to load a converter for a specific . + Tries to load a converter for a specific . - - The host app string for which a is desired. see - - - The converter for the specific + The host app string for which a is desired. see + The converter for the specific Thrown if the requested converter failed to load - Needed so we can properly deserialize all the Base-derived objects from Core itself. + Needed so we can properly deserialize all the Base-derived objects from Core itself. - Local installations store kits in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits - Admin/System-wide installations in C:\ProgramData\Speckle\Kits + Local installations store kits in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits + Admin/System-wide installations in C:\ProgramData\Speckle\Kits - Returns a list of all the kits found on this user's device. + Returns a list of all the kits found on this user's device. - Returns a list of all the types found in all the kits on this user's device. + Returns a list of all the types found in all the kits on this user's device. - Checks whether a specific kit exists. + Checks whether a specific kit exists. - Gets a specific kit. + Gets a specific kit. - Gets the default Speckle provided kit, "Objects". + Gets the default Speckle provided kit, "Objects". - Returns all the kits with potential converters for the software app. + Returns all the kits with potential converters for the software app. - Tells the kit manager to initialise from a specific location. + Tells the kit manager to initialise from a specific location. - Indicates if a given assembly references another which is identified by its name. + Indicates if a given assembly references another which is identified by its name. The assembly which will be probed. The reference assembly name. @@ -1340,75 +1316,71 @@ - Anonymous telemetry to help us understand how to make a better Speckle. - This really helps us to deliver a better open source project and product! + Anonymous telemetry to help us understand how to make a better Speckle. + This really helps us to deliver a better open source project and product! - Default Mixpanel events + Default Mixpanel events - Event triggered when data is sent to a Speckle Server + Event triggered when data is sent to a Speckle Server - Event triggered when data is received from a Speckle Server + Event triggered when data is received from a Speckle Server - Event triggered when a node is executed in a visual programming environment, it should contain the name of the action - and the host application + Event triggered when a node is executed in a visual programming environment, it should contain the name of the action and the host application - Event triggered when an action is executed in Desktop UI, it should contain the name of the action and the host - application + Event triggered when an action is executed in Desktop UI, it should contain the name of the action and the host application - Event triggered when a node is first created in a visual programming environment, it should contain the name of the - action and the host application + Event triggered when a node is first created in a visual programming environment, it should contain the name of the action and the host application - Event triggered when the import/export alert is launched or closed + Event triggered when the import/export alert is launched or closed - Event triggered when the connector is registered + Event triggered when the connector is registered - Event triggered by the Mapping Tool + Event triggered by the Mapping Tool - Cached email + Cached email - Cached server URL + Cached server URL - Tracks an event without specifying the email and server. - It's not always possible to know which account the user has selected, especially in visual programming. - Therefore we are caching the email and server values so that they can be used also when nodes such as "Serialize" are - used. - If no account info is cached, we use the default account data. + Tracks an event without specifying the email and server. + It's not always possible to know which account the user has selected, especially in visual programming. + Therefore we are caching the email and server values so that they can be used also when nodes such as "Serialize" are used. + If no account info is cached, we use the default account data. Name of the even Additional parameters to pass in to event @@ -1416,7 +1388,7 @@ - Tracks an event from a specified account, anonymizes personal information + Tracks an event from a specified account, anonymizes personal information Account to use, it will be anonymized Name of the event @@ -1425,7 +1397,7 @@ - Tracks an event from a specified email and server, anonymizes personal information + Tracks an event from a specified email and server, anonymizes personal information Email of the user anonymized Server URL anonymized @@ -1433,94 +1405,69 @@ Additional parameters to pass to the event True if it's an action performed by a logged user - - - Anonymous telemetry to help us understand how to make a better Speckle. - This really helps us to deliver a better open source project and product! - - - - - Initializes Sentry - - - - - Captures an Exception and makes sure Sentry is initialized - - - - - - - - Adds a Breadcrumb and makes sure Sentry is initialized - - - - Anonymous telemetry to help us understand how to make a better Speckle. - This really helps us to deliver a better open source project and product! + Anonymous telemetry to help us understand how to make a better Speckle. + This really helps us to deliver a better open source project and product! - Set from the connectors, defines which current host application we're running on. + Set from the connectors, defines which current host application we're running on. - Set from the connectors, defines which current host application we're running on - includes the version. + Set from the connectors, defines which current host application we're running on - includes the version. - Configuration object for the Speckle logging system. + Configuration object for the Speckle logging system. - Flag to enable enhanced log context. This adds the following enrich calls: - - WithClientAgent - - WithClientIp - - WithExceptionDetails + Flag to enable enhanced log context. This adds the following enrich calls: + - WithClientAgent + - WithClientIp + - WithExceptionDetails - Flag to enable console sink + Flag to enable console sink - Flag to enable File sink + Flag to enable File sink - Flag to enable Sentry sink + Flag to enable Sentry sink - Flag to enable Seq sink + Flag to enable Seq sink - Log events bellow this level are silently dropped + Log events bellow this level are silently dropped - Flag to override the default Sentry DNS + Flag to override the default Sentry DNS - Default SpeckleLogConfiguration constructor. - These are the sane defaults we should be using across connectors. + Default SpeckleLogConfiguration constructor. + These are the sane defaults we should be using across connectors. Log events bellow this level are silently dropped Flag to enable console log sink @@ -1531,17 +1478,17 @@ - Configurator class for a standardized logging system across Speckle (sharp). + Configurator class for a standardized logging system across Speckle (sharp). - Initialize logger configuration for a global Serilog.Log logger. + Initialize logger configuration for a global Serilog.Log logger. - Create a new fully configured Logger instance. + Create a new fully configured Logger instance. Name of the application using this SDK ie.: "Rhino" Public version slug of the application using this SDK ie.: "2023" @@ -1550,150 +1497,220 @@ - Flags an object's property as being detachable. - - If set to true the default serialiser will persist it separately, and add a reference to the property's value - in the original object. - - Only applies to properties of types derived from the Base class. + Flags an object's property as being detachable. + If set to true the default serialiser will persist it separately, and add a reference to the property's value in the original object. + Only applies to properties of types derived from the Base class. - Flags an object's property as being detachable. - - If set to true the default serialiser will persist it separately, and add a reference to the property's value - in the original object. - - Only applies to properties of types derived from the Base class. + Flags an object's property as being detachable. + If set to true the default serialiser will persist it separately, and add a reference to the property's value in the original object. + Only applies to properties of types derived from the Base class. Wether to detach the property or not. - Flags a list or array as splittable into chunks during serialisation. These chunks will be recomposed on - deserialisation into the original list. Note: this attribute should be used in conjunction with - . - - Use this attribute on properties that can become very long and are not worth detaching into individual - elements. - - - Objects per chunk: for simple types, like numbers, use a high value (>10000); for other objects, use a more - conservative number depending on their serialised size. - + Flags a list or array as splittable into chunks during serialisation. These chunks will be recomposed on deserialisation into the original list. Note: this attribute should be used in conjunction with . + Use this attribute on properties that can become very long and are not worth detaching into individual elements. + Objects per chunk: for simple types, like numbers, use a high value (>10000); for other objects, use a more conservative number depending on their serialised size. - Base class for all Speckle object definitions. Provides unified hashing, type extraction and serialisation. - When developing a speckle kit, use this class as a parent class. - - Dynamic properties naming conventions: - - - 👉 "__" at the start of a property means it will be ignored, both for hashing and serialisation (e.g., - "__ignoreMe"). - - - 👉 "@" at the start of a property name means it will be detached (when serialised with a transport) - (e.g.((dynamic)obj)["@meshEquivalent"] = ...) . - + Base class for all Speckle object definitions. Provides unified hashing, type extraction and serialisation. + When developing a speckle kit, use this class as a parent class. + Dynamic properties naming conventions: + 👉 "__" at the start of a property means it will be ignored, both for hashing and serialisation (e.g., "__ignoreMe"). + 👉 "@" at the start of a property name means it will be detached (when serialised with a transport) (e.g.((dynamic)obj)["@meshEquivalent"] = ...) . - A speckle object's id is an unique hash based on its properties. - - NOTE: this field will be null unless the object was deserialised from a source. Use the - function to get it. - + A speckle object's id is an unique hash based on its properties. NOTE: this field will be null unless the object was deserialised from a source. Use the function to get it. - This property will only be populated if the object is retreieved from storage. Use - otherwise. + This property will only be populated if the object is retreieved from storage. Use otherwise. - Secondary, ideally host application driven, object identifier. + Secondary, ideally host application driven, object identifier. - Holds the type information of this speckle object, derived automatically - from its assembly name and inheritance. + Holds the type information of this speckle object, derived automatically + from its assembly name and inheritance. - Gets the id (a unique hash) of this object. ⚠️ This method fully serializes the object, which in the case of large - objects (with many sub-objects), has a tangible cost. Avoid using it! - - Hint: Objects that are retrieved/pulled from a server/local cache do have an id (hash) property - pre-populated. - - Note:The hash of a decomposed object differs from the hash of a non-decomposed object. + Gets the id (a unique hash) of this object. ⚠️ This method fully serializes the object, which in the case of large objects (with many sub-objects), has a tangible cost. Avoid using it! + Hint: Objects that are retrieved/pulled from a server/local cache do have an id (hash) property pre-populated. + Note:The hash of a decomposed object differs from the hash of a non-decomposed object. If true, will decompose the object in the process of hashing. - Attempts to count the total number of detachable objects. + Attempts to count the total number of detachable objects. The total count of the detachable children + 1 (itself). - Creates a shallow copy of the current base object. - This operation does NOT copy/duplicate the data inside each prop. - The new object's property values will be pointers to the original object's property value. + Creates a shallow copy of the current base object. + This operation does NOT copy/duplicate the data inside each prop. + The new object's property values will be pointers to the original object's property value. A shallow copy of the original object. - For blobs, the id is the same as the file hash. Please note, when deserialising, the id will be set from the original - hash generated on sending. + For blobs, the id is the same as the file hash. Please note, when deserialising, the id will be set from the original hash generated on sending. + + + + + A simple container for organising objects within a model and preserving object hierarchy. + A container is defined by a human-readable , a unique , and its list of contained . + The can include an unrestricted number of objects including additional nested s. + + + A can be for example a Layer in Rhino/AutoCad, a collection in Blender, or a Category in Revit. + The location of each collection in the hierarchy of collections in a commit will be retrieved through commit traversal. + + + + + Constructor for a basic collection. + The human-readable name of this collection + + + + The human-readable name of the . + + This name is not necessarily unique within a commit. Set the applicationId for a unique identifier. + + + + The type of this collection + + + + + The elements contained in this . + + + This can include additional nested s. + + + + + Abstract Builder class for a root commit object. + + The native object data type needed as input for building + + It is designed to be inherited by a host app specific implementation, + to give connectors flexibility in constructing their objects. + Inheritors should also create some function to add + + + + Special appId symbol for the root object + + + app id -> base + + + Base -> Tuple{Parent App Id, propName} ordered by priority + + + + Given the parameters, builds connector specific + to be applied when is called. + + + + + + + Iterates through the converted objects applying + + + Can be overriden to adjust exactly which objects get automatically applied, + or to inject additional items into the dict that should not be automatically applied. + + + + + + Sets information on how a given object should be nested in the commit tree. + encodes the order in which we should try and nest the given + when is called + + The object to be nested + Information about how the object ideally should be nested, in order of priority + + + + For each object in + + + + + + + + Will attempt to find and nest the object + under the first valid parent according to the dictionary. + + + A parent is considered valid if + 1. Is non null + 2. Is in the dictionary + 3. Has (or can dynamically accept) a typed property with the propName specified by the item + 4. Said can accept the object's type + + + + Thrown when no valid parent was found for given - Base class implementing a bunch of nice dynamic object methods, like adding and removing props dynamically. Makes c# - feel like json. - Orginally adapted from Rick Strahl 🤘 - https://weblog.west-wind.com/posts/2012/feb/08/creating-a-dynamic-extensible-c-expando-object + Base class implementing a bunch of nice dynamic object methods, like adding and removing props dynamically. Makes c# feel like json. + Orginally adapted from Rick Strahl 🤘 + https://weblog.west-wind.com/posts/2012/feb/08/creating-a-dynamic-extensible-c-expando-object - Default value for + Default value for - The actual property bag, where dynamically added props are stored. + The actual property bag, where dynamically added props are stored. - Sets and gets properties using the key accessor pattern. E.g.: - - 
((dynamic)myObject)["superProperty"] = 42;
- + Sets and gets properties using the key accessor pattern. E.g.: + 
((dynamic)myObject)["superProperty"] = 42;
 - Gets properties via the dot syntax. - - 
((dynamic)myObject).superProperty;
- + Gets properties via the dot syntax. + 
((dynamic)myObject).superProperty;
 @@ -1701,10 +1718,8 @@ - Sets properties via the dot syntax. - - 
((dynamic)myObject).superProperty = something;
- + Sets properties via the dot syntax. + 
((dynamic)myObject).superProperty = something;
 @@ -1712,318 +1727,316 @@ - Gets all of the property names on this class, dynamic or not. - - + Gets all of the property names on this class, dynamic or not. + - Gets the names of the defined class properties (typed). + Gets the names of the defined class properties (typed). - Gets the defined (typed) properties of this object. + Gets the defined (typed) properties of this object. - Gets the names of the typed and dynamic properties that don't have a [SchemaIgnore] attribute. + Gets the names of the typed and dynamic properties that don't have a [SchemaIgnore] attribute. - Gets the typed and dynamic properties. + Gets the typed and dynamic properties. - - Specifies which members should be included in the resulting dictionary. Can be - concatenated with "|" - + Specifies which members should be included in the resulting dictionary. Can be concatenated with "|" A dictionary containing the key's and values of the object. - Gets the dynamically added property names only. + Gets the dynamically added property names only. - This attribute is used internally to hide the this[key]{get; set;} property from inner reflection on members. - For more info see this discussion: - https://speckle.community/t/why-do-i-keep-forgetting-base-objects-cant-use-item-as-a-dynamic-member/3246/5 + This attribute is used internally to hide the this[key]{get; set;} property from inner reflection on members. + For more info see this discussion: https://speckle.community/t/why-do-i-keep-forgetting-base-objects-cant-use-item-as-a-dynamic-member/3246/5 - Represents all different types of members that can be returned by + Represents all different types of members that can be returned by - The typed members of the DynamicBase object + The typed members of the DynamicBase object - The dynamically added members of the DynamicBase object + The dynamically added members of the DynamicBase object - The typed members flagged with attribute. + The typed members flagged with attribute. - The typed members flagged with attribute. + The typed members flagged with attribute. - The typed methods flagged with TODO: + The typed methods flagged with TODO: - All the typed members, including ones with or - attributes. + All the typed members, including ones with or attributes. - All the members, including dynamic and instance members flagged with or - attributes + All the members, including dynamic and instance members flagged with or attributes - Provides access to each base object in the traverse function, and decides whether the traverse function should - continue traversing it's children or not. + Provides access to each base object in the traverse function, and decides whether the traverse function should continue traversing it's children or not. - Should return 'true' if you wish to stop the traverse behaviour, 'false' otherwise. + Should return 'true' if you wish to stop the traverse behaviour, 'false' otherwise. - Traverses through the object and its children. - Only traverses through the first occurrence of a object (to prevent infinite recursion on - circular references) + Traverses through the object and its children. + Only traverses through the first occurrence of a object (to prevent infinite recursion on circular references) The root object of the tree to flatten - - Optional predicate function to determine whether to break (or continue) traversal of a - object's children. - - A flat List of objects. - + Optional predicate function to determine whether to break (or continue) traversal of a object's children. + A flat List of objects. + - Depth-first traversal of the specified object and all of its children as a deferred - Enumerable, with a function to break the traversal. + Depth-first traversal of the specified object and all of its children as a deferred Enumerable, with a function to break the traversal. + + The object to traverse. + Predicate function to determine whether to break (or continue) traversal of a object's children. + Deferred Enumerable of the objects being traversed (iterable only once). + + + + see + + + + elements + + + + see - The object to traverse. - - Predicate function to determine whether to break (or continue) traversal of a - object's children. - - Deferred Enumerable of the objects being traversed (iterable only once). + + + Value to set + - Wrapper around other, third party, classes that are not coming from a speckle kit. - - Serialization and deserialization of the base object happens through default Newtonsoft converters. If your - object does not de/serialize correctly, this class will not prevent that from happening. - - - Limitations: - - - Base object needs to be serializable. - - Inline collection declarations with values do not behave correctly. - - Your class needs to have a void constructor. - - Probably more. File a bug! + Wrapper around other, third party, classes that are not coming from a speckle kit. + Serialization and deserialization of the base object happens through default Newtonsoft converters. If your object does not de/serialize correctly, this class will not prevent that from happening. + Limitations: + - Base object needs to be serializable. + - Inline collection declarations with values do not behave correctly. + - Your class needs to have a void constructor. + - Probably more. File a bug! - See for limitations of this approach. + See for limitations of this approach. - See for limitations of this approach. + See for limitations of this approach. - The original object. + The original object. - In short, this helps you chunk big things into smaller things. - See the following reference. + In short, this helps you chunk big things into smaller things. + See the following reference. - A simple wrapper to keep track of the relationship between speckle objects and their host-application siblings in - cases where the - cannot correspond with the (ie, on - receiving operations). + A simple wrapper to keep track of the relationship between speckle objects and their host-application siblings in cases where the + cannot correspond with the (ie, on receiving operations). - ID of the object from host application that generated it. + ID of the object from host application that generated it. - The container for the object in the native application + The container for the object in the native application - Indicates if conversion is supported by the converter + Indicates if conversion is supported by the converter - The fallback values if direct conversion is not available, typically displayValue + The fallback values if direct conversion is not available, typically displayValue - The Speckle id (on receive) or native id (on send) + The Speckle id (on receive) or native id (on send) - Used to retrieve this object in ProgressReport.GetReportObject(), typically to pass between connectors - and converters + Used to retrieve this object in ProgressReport.GetReportObject(), typically to pass between connectors and converters - A descriptive string to describe the object. Use the object type as default. + A descriptive string to describe the object. Use the object type as default. - The created object ids associated with this object + The created object ids associated with this object - On send, this is currently left empty as generating Speckle ids would be performance expensive + On send, this is currently left empty as generating Speckle ids would be performance expensive - Conversion status of object + Conversion status of object - Conversion notes or other important information to expose to the user + Conversion notes or other important information to expose to the user - Converted objects corresponding to this object + Converted objects corresponding to this object - Used during receive for convenience, corresponds to CreatedIds + Used during receive for convenience, corresponds to CreatedIds - Keeps track of the conversion process + Keeps track of the conversion process - Keeps track of errors in the conversions. + Keeps track of errors in the conversions. - Keeps track of HANDLED errors that occur during send/recieve commands. + Keeps track of HANDLED errors that occur during send/recieve commands. - Handled errors specific to the conversion, should be added to ConversionErrors - Unhandleable errors (i.e. that lead to the entire send/receive failing) should be Thrown instead. + Handled errors specific to the conversion, should be added to ConversionErrors + Unhandleable errors (i.e. that lead to the entire send/receive failing) should be Thrown instead. - Traverses until finds a convertable object (or fallback) then traverses members + Default traversal rule that ideally should be used by all connectors + + Treats convertable objects and objects with displayValues as "convertable" such that only elements and dynamic props will be traversed + - Traverses until finds a convertable object then HALTS deeper traversal + Traverses until finds a convertable object then HALTS deeper traversal + + Current does traversal, + so this traversal is a shallow traversal for directly convertable objects, + and a deep traversal for all other types + - Traverses until finds a convertable object (or fallback) then traverses members + Traverses until finds a convertable object (or fallback) then traverses members - Given object, will recursively traverse members according to the provided traversal rules. + Given object, will recursively traverse members according to the provided traversal rules. The object to traverse members - - Lazily returns objects found during traversal (including ), - wrapped within a - + Lazily returns objects found during traversal (including ), wrapped within a - Traverses supported Collections yielding objects. - Does not traverse , only (potentially nested) collections. + Traverses supported Collections yielding objects. + Does not traverse , only (potentially nested) collections. The value to traverse - Interface for a definition of conditional traversal of objects. + Interface for a definition of conditional traversal of objects. The member names to traverse - Return may include member names doesn't have + Return may include member names doesn't have - Evaluates the traversal rule given + Evaluates the traversal rule given - The "traverse none" rule that always holds true + The "traverse none" rule that always holds true - A traversal rule defines the conditional traversal behaviour when traversing a given objects. - Specifies what members to traverse if any provided are met. + A traversal rule defines the conditional traversal behaviour when traversing a given objects. + Specifies what members to traverse if any provided are met. Follows the builder pattern to ensure that a rule is complete before usable, see usages @@ -2032,44 +2045,41 @@ - Interface for traversal rule in a building (unusable) state + Interface for traversal rule in a building (unusable) state - Adds a condition to this rule. This rule will hold true when ANY of its conditions holds true. + Adds a condition to this rule. This rule will hold true when ANY of its conditions holds true. Traversal rule in a building (unusable) state - Delegate for selecting members (by member name) of an given object + Delegate for selecting members (by member name) of an given object - Interface for traversal rule in a building (unusable) state + Interface for traversal rule in a building (unusable) state - - - Function returning the members that should be traversed for objects where this rule - holds - + + Function returning the members that should be traversed for objects where this rule holds Traversal rule in a usable state - Wrapper method around hashing functions. Defaults to md5. + Wrapper method around hashing functions. Defaults to md5. - Retrieves the simple type properties of an object + Retrieves the simple type properties of an object @@ -2079,7 +2089,7 @@ - Sets the properties of an object with the properties of a base object + Sets the properties of an object with the properties of a base object @@ -2087,7 +2097,7 @@ - Chunks a list into pieces. + Chunks a list into pieces. @@ -2096,263 +2106,254 @@ - Property that describes the type of the object. + Property that describes the type of the object. - The sync transport. This transport will be used synchronously. + The sync transport. This transport will be used synchronously. - The JSON string of the object to be deserialized - A typed object deserialized from the - Thrown when - - Thrown when deserializes to a type other than - - + The JSON string of the object to be deserialized + A typed object deserialized from the + Thrown when + Thrown when deserializes to a type other than - Property that describes the type of the object. + Property that describes the type of the object. - The sync transport. This transport will be used synchronously. + The sync transport. This transport will be used synchronously. - List of transports to write to. + List of transports to write to. - Reinitializes the lineage, and other variables that get used during the - json writing process. + Reinitializes the lineage, and other variables that get used during the + json writing process. - Keeps track of wether current property pointer is marked for detachment. + Keeps track of wether current property pointer is marked for detachment. - Keeps track of the hash chain through the object tree. + Keeps track of the hash chain through the object tree. - Dictionary of object if and its subsequent closure table (a dictionary of hashes and min depth at which they are - found). + Dictionary of object if and its subsequent closure table (a dictionary of hashes and min depth at which they are found). - Property that describes the type of the object. + Property that describes the type of the object. - The sync transport. This transport will be used synchronously. + The sync transport. This transport will be used synchronously. - Flushes kit's (discriminator, type) cache. Useful if you're dynamically loading more kits at runtime, that provide - better coverage of what you're deserialising, and it's now somehow poisoned because the higher level types were not - originally available. + Flushes kit's (discriminator, type) cache. Useful if you're dynamically loading more kits at runtime, that provide better coverage of what you're deserialising, and it's now somehow poisoned because the higher level types were not originally available. - Interface defining the contract for transport implementations. + Interface defining the contract for transport implementations. - Human readable name for the transport + Human readable name for the transport - Extra descriptor properties of the given transport. + Extra descriptor properties of the given transport. - Show how much time the transport was busy for. + Show how much time the transport was busy for. - Show how many objects the transport saved. + Show how many objects the transport saved. - Should be checked often and gracefully stop all in progress sending if requested. + Should be checked often and gracefully stop all in progress sending if requested. - Used to report progress during the transport's longer operations. + Used to report progress during the transport's longer operations. - Used to report errors during the transport's longer operations. + Used to report errors during the transport's longer operations. - Optional: signals to the transport that writes are about to begin. + Optional: signals to the transport that writes are about to begin. - Optional: signals to the transport that no more items will need to be written. + Optional: signals to the transport that no more items will need to be written. - Saves an object. + Saves an object. The hash of the object. The full string representation of the object. - Saves an object, retrieving its serialised version from the provided transport. + Saves an object, retrieving its serialised version from the provided transport. The hash of the object. The transport from where to retrieve it. - Awaitable method to figure out whether writing is completed. + Awaitable method to figure out whether writing is completed. - Gets an object. + Gets an object. The object's hash. - Copies the parent object and all its children to the provided transport. + Copies the parent object and all its children to the provided transport. The id of the object you want to copy. The transport you want to copy the object to. - - (Optional) an action that will be invoked once, when the amount of object - children to be copied over is known. - + (Optional) an that will be invoked once, when the number of object children to be copied over is known. The string representation of the root object. + The transport was in an invalid state + The provided arguments are not valid + - Checks if objects are present in the transport + Checks if objects are present in the transport List of object ids to check - - A dictionary with the specified object ids as keys and boolean values, whether each object is present in the - transport or not - + A dictionary with the specified object ids as keys and boolean values, whether each object is present in the transport or not - An in memory storage of speckle objects. + An in memory storage of speckle objects. - Sends data to a speckle server. + Sends data to a speckle server. - https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ + https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ - https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ + https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ - Callback when sending batches. Parameters: object count, total bytes sent + Callback when sending batches. Parameters: object count, total bytes sent - Timer that ensures queue is consumed if less than MAX_TRANSACTION_SIZE objects are being sent. + Timer that ensures queue is consumed if less than MAX_TRANSACTION_SIZE objects are being sent. - Returns all the objects in the store. Note: do not use for large collections. + Returns all the objects in the store. Note: do not use for large collections. - Deletes an object. Note: do not use for any speckle object transport, as it will corrupt the database. + Deletes an object. Note: do not use for any speckle object transport, as it will corrupt the database. - Updates an object. + Updates an object. - Awaits untill write completion (ie, the current queue is fully consumed). + Awaits untill write completion (ie, the current queue is fully consumed). - Returns true if the current write queue is empty and comitted. + Returns true if the current write queue is empty and comitted. - Adds an object to the saving queue. + Adds an object to the saving queue. - Directly saves the object in the db. + Directly saves the object in the db. - Gets an object. + Gets an object. - Waits until the provided function returns true. + Waits until the provided function returns true. diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.deps.json b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.deps.json index 1296e51..8b4f960 100644 --- a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.deps.json +++ b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.deps.json @@ -7,10 +7,10 @@ "targets": { ".NETStandard,Version=v2.0": {}, ".NETStandard,Version=v2.0/": { - "Objects/2.1.1": { + "Objects/2.0.999-local": { "dependencies": { "NETStandard.Library": "2.0.3", - "Speckle.Core": "2.1.0" + "Speckle.Core": "2.0.999-local" }, "runtime": { "Objects.dll": {} @@ -541,7 +541,7 @@ } }, "libraries": { - "Objects/2.1.1": { + "Objects/2.0.999-local": { "type": "project", "serviceable": false, "sha512": "" diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.dll b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.dll index 08e8ddf..4440531 100644 Binary files a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.dll and b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.dll differ diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.pdb b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.pdb index b1923ff..fb9c05f 100644 Binary files a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.pdb and b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.pdb differ diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.xml b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.xml index 1fb29d7..be7c945 100644 --- a/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.xml +++ b/Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.xml @@ -142,8 +142,8 @@ Indicates if this link needs temporary placeholder objects to be created first when receiving - - Placeholder geometry are curves. + + Placeholder geometry are curves. For example, U-bend links need temporary pipes to be created first, if one or more linked pipes have not yet been created in the network. @@ -179,13 +179,13 @@ - If True it's a Shared Parameter, in which case the ApplicationId field will contain this parameter GUID, + If True it's a Shared Parameter, in which case the ApplicationId field will contain this parameter GUID, otherwise it will store its BuiltInParameter name - True = Type Parameter, False = Instance Parameter + True = Type Parameter, False = Instance Parameter @@ -279,6 +279,24 @@ Assign units when using this constructor due to , , and params + + + The base curve of the featureline + + + + + The points constructing the Featureline + + + Can include both intersection and elevation points + + + + + The 3D curves generated from the curve and points of the featureline + + SchemaBuilder constructor for a Speckle level @@ -351,6 +369,45 @@ Represents a sub-curve of a three-dimensional circle. + + + + + + Constructs a new using angle values. + + The Plane where the arc will be drawn + The radius of the Arc + The angle formed between the start point and the X Axis of the plane + The angle formed between the end point and the X Axis of the plane + The total angle of the Arc in Radians + The object's units + The object's unique application ID + + + + Initialise an `Arc` using the arc angle and the start and end points. + The radius, midpoint, start angle, and end angle will be calculated. + For now, this assumes 2D arcs on the XY plane + + The start point of the arc + The end point of the arc + The arc angle + Units (defaults to "m") + ID given to the arc in the authoring programme (defaults to null) + + + + Initialise an `Arc` using a plane, the arc angle and the start and end points. + The radius, midpoint, start angle, and end angle will be calculated. + + The Plane where the arc will be drawn + The start point of the arc + The end point of the arc + The arc angle + Units (defaults to "m") + ID given to the arc in the authoring programme (defaults to null) + The radius of the @@ -376,9 +433,6 @@ Gets or sets the plane of the . The plane origin is the center. - - - The start of the @@ -394,58 +448,28 @@ The end of the - - + + + The units this object was specified in. + - + - - - The units this object was specified in. - - - + - - - Constructs a new using angle values. - - The Plane where the arc will be drawn - The radius of the Arc - The angle formed between the start point and the X Axis of the plane - The angle formed between the end point and the X Axis of the plane - The total angle of the Arc in Radians - The object's units - The object's unique application ID + + - - - Initialise an `Arc` using the arc angle and the start and end points. - The radius, midpoint, start angle, and end angle will be calculated. - For now, this assumes 2D arcs on the XY plane - - The start point of the arc - The end point of the arc - The arc angle - Units (defaults to "m") - ID given to the arc in the authoring programme (defaults to null) + + - - - Initialise an `Arc` using a plane, the arc angle and the start and end points. - The radius, midpoint, start angle, and end angle will be calculated. - - The Plane where the arc will be drawn - The start point of the arc - The end point of the arc - The arc angle - Units (defaults to "m") - ID given to the arc in the authoring programme (defaults to null) + + @@ -463,16 +487,24 @@ A list of numbers A new with the values assigned from the list. - - + + + Represents a 3-dimensional box oriented on a plane. + - + - + - Represents a 3-dimensional box oriented on a plane. + Constructs a new instance with a and coordinate intervals for all 3 axis {x , y , z} + The plane the box will be oriented by. + The range of coordinates (min, max) for the X axis + The range of coordinates (min, max) for the Y axis + The range of coordinates (min, max) for the Z axis + The units the coordinates are in. + The unique application ID of the object. @@ -494,15 +526,6 @@ Gets or sets the that defines the min and max coordinate in the Y direction - - - - - - - - - The units this object's coordinates are in. @@ -511,33 +534,24 @@ This should be one of - + - - - Constructs a new instance with a and coordinate intervals for all 3 axis {x , y , z} - - The plane the box will be oriented by. - The range of coordinates (min, max) for the X axis - The range of coordinates (min, max) for the Y axis - The range of coordinates (min, max) for the Z axis - The units the coordinates are in. - The unique application ID of the object. + + + + + Represents a "Boundary Representation" Solid - - - - - - - - + + + Initializes a new instance of class. + @@ -547,9 +561,6 @@ This should be one of - - - Gets or sets the list of surfaces in this instance. @@ -661,10 +672,17 @@ Gets or sets the list of surfaces in this instance. - - - Initializes a new instance of class. - + + + + + + + + + + + @@ -742,6 +760,20 @@ Represents a circular curve based on a base and a as radius. + + + Constructs an empty instance. + + + + + Constructs a new instance. + + The plane where the circle lies + The radius of the circle + The units the circle is modeled in + The unique ID of this circle in a specific application + The radius of the circle @@ -752,37 +784,23 @@ The the circle lies in. + + + The units this object was modeled in. + + - + - + - - - The units this object was modeled in. - - - - - Constructs an empty instance. - - - - - Constructs a new instance. - - The plane where the circle lies - The radius of the circle - The units the circle is modeled in - The unique ID of this circle in a specific application - Returns the coordinates of this as a list of numbers @@ -802,6 +820,19 @@ You should not use this for anything. Access coordinates using X,Y,Z and weight fields. + + + Constructs an empty instance. + + + + + Constructs a new instance based on displayValue a polyline. + + The polyline that will be this curve's + The units this curve is be modelled in + The unique ID of this curve in a specific application + "True" if weights differ, "False" if weights are the same. @@ -817,38 +848,31 @@ Gets or sets the knots for this . Count should be equal to count + + 1. + + + The units this object was specified in. + + - + - + - + - - - The units this object was specified in. - + + - - - Constructs an empty instance. - - - - - Constructs a new instance based on displayValue a polyline. - - The polyline that will be this curve's - The units this curve is be modelled in - The unique ID of this curve in a specific application + + as list of s @@ -867,11 +891,32 @@ The list of values representing this A new with the provided values. - - + + + Initializes a new instance of the class. + This constructor is only intended for serialization/deserialization purposes. + Use other constructors to manually create ellipses. + - - + + + Initializes a new instance of the class. + + The plane to draw the ellipse in. + First radius of the ellipse. + Second radius of the ellipse. + Application ID, defaults to null. + + + + Initializes a new instance of the class. + + The plane to draw the ellipse in. + First radius of the ellipse. + Second radius of the ellipse. + The curve's internal parametrization domain. + The domain to trim the curve with. Will be null if the ellipse is not trimmed. + Application ID, defaults to null. @@ -888,11 +933,6 @@ Gets or sets the plane to draw this ellipse in. - - - Gets or sets the domain interval for this . - - Gets or set the domain interval to trim this with. @@ -901,73 +941,60 @@ - - + + + Gets or sets the domain interval for this . + - - - Initializes a new instance of the class. - This constructor is only intended for serialization/deserialization purposes. - Use other constructors to manually create ellipses. - + + - + - Initializes a new instance of the class. + OBSOLETE - This is just here for backwards compatibility. + You should not use this for anything. Access coordinates using start and end point. - The plane to draw the ellipse in. - First radius of the ellipse. - Second radius of the ellipse. - Application ID, defaults to null. - + - Initializes a new instance of the class. + Constructs a new mesh from it's raw values. - The plane to draw the ellipse in. - First radius of the ellipse. - Second radius of the ellipse. - The curve's internal parametrization domain. - The domain to trim the curve with. Will be null if the ellipse is not trimmed. - Application ID, defaults to null. + + + + + + - + + Vertex colors as ARGB s + + - OBSOLETE - This is just here for backwards compatibility. - You should not use this for anything. Access coordinates using start and end point. + The unit's this is in. + This should be one of - - Vertex colors as ARGB s + + - + - + - - - The unit's this is in. - This should be one of - + + - - - Constructs a new mesh from it's raw values. - - - - - - - + + @@ -982,10 +1009,10 @@ - Gets a texture coordinate as a by + Gets a texture coordinate as a by The index of the texture coordinate - Texture coordinate as a + Texture coordinate as a @@ -994,7 +1021,7 @@ This alignment is what is expected by most applications.
 - If the calling application expects + If the calling application expects vertices.count == textureCoordinates.count Then this method should be called by the MeshToNative method before parsing and to ensure compatibility with geometry originating from applications that map to using vertex instance index (rather than vertex index) @@ -1002,17 +1029,27 @@ , , and lists will be modified to contain no shared vertices (vertices shared between polygons) - - - - - - A 3-dimensional Plane consisting of an origin , and 3 as it's X, Y and Z axis. + + + Constructs an empty + + + + + Constructs a new given it's individual values. + + The point to be used as origin + The vector to be used as Z axis + The vector to be used as the X axis + The vector to be used as the Y axis + The units the coordinates are in. + The unique ID of this polyline in a specific application + The s origin point. @@ -1039,21 +1076,11 @@ This should be one of - - - Constructs an empty - + + - - - Constructs a new given it's individual values. - - The point to be used as origin - The vector to be used as Z axis - The vector to be used as the X axis - The vector to be used as the Y axis - The units the coordinates are in. - The unique ID of this polyline in a specific application + + @@ -1068,12 +1095,6 @@ The list of values representing this plane A new with the provided values. - - - - - - A 3-dimensional point @@ -1082,14 +1103,6 @@ TODO: The Point class does not override the Equality operator, which means that there may be cases where `Equals` is used instead of `==`, as the comparison will be done by reference, not value. - - - Gets or sets the coordinates of the - - - - - @@ -1109,6 +1122,11 @@ The Vector whose coordinates will be used for the Point + + + Gets or sets the coordinates of the + + The x coordinate of the point. @@ -1130,6 +1148,15 @@ This should be one of the units specified in + + + + + + + + + Returns the coordinates of this as a list of numbers @@ -1184,17 +1211,21 @@ point for distance measurement The length of the line between this and the other point - - - - - - A collection of points, with color and size support. + + + Constructs an empty + + + + Flat list of x,y,z coordinates + Optional list of colors + Optional list of sizes + Gets or sets the list of points of this , stored as a flat list of coordinates [x1,y1,z1,x2,y2,...] @@ -1210,28 +1241,14 @@ Gets or sets the list of sizes of this 's points. - - - The unit's this is in. This should be one of - - - Constructs an empty - - - - Flat list of x,y,z coordinates - Optional list of colors - Optional list of sizes - - - as list of s - when list is malformed + + @@ -1239,19 +1256,30 @@ + + as list of s + when list is malformed + A curve that is comprised of multiple curves connected. - + - Gets or sets the list of segments that comprise this + Constructs a new empty instance. - + - The internal domain of this curve. + Constructs a new empty with defined units and unique application ID. + + The units the Polycurve was modelled in. + The unique ID of this polyline in a specific application + + + + Gets or sets the list of segments that comprise this @@ -1260,32 +1288,28 @@ (i.e. The start point of the first segment and the end point of the last segment coincide.) - - - - - - - - - The unit's this is in. This should be one of - + - Constructs a new empty instance. + The internal domain of this curve. - - - Constructs a new empty with defined units and unique application ID. - - The units the Polycurve was modelled in. - The unique ID of this polyline in a specific application + + + + + + + + + + + @@ -1303,46 +1327,13 @@ Creates a new based on a list of coordinates and the unit they're drawn in. - - The list of values representing this polycurve - A new with the provided values. - - - - - - - A polyline curve, defined by a set of vertices. - - - - - Gets or sets the raw coordinates that define this polyline. Use GetPoints instead to access this data as instances instead. - - - - - If true, do not add the last point to the value list. Polyline first and last points should be unique. - - - - - The internal domain of this curve. - - - - - - - - - - + + The list of values representing this polycurve + A new with the provided values. - + - The unit's this is in. - This should be one of + A polyline curve, defined by a set of vertices. @@ -1366,33 +1357,28 @@ The units the coordinates are in. The unique ID of this polyline in a specific application - + - Gets the list of points representing the vertices of this polyline. + Gets or sets the raw coordinates that define this polyline. Use GetPoints instead to access this data as instances instead. - - This function may be suboptimal for performance for polylines with many points - as List of s - when list is malformed - - + - Returns the values of this as a list of numbers + If true, do not add the last point to the value list. Polyline first and last points should be unique. - A list of values representing the polyline. - + - Creates a new based on a list of coordinates and the unit they're drawn in. + The unit's this is in. + This should be one of - The list of values representing this polyline - A new with the provided values. - - + + + Gets the list of points representing the vertices of this polyline. + - + @@ -1443,11 +1429,58 @@ + + + The internal domain of this curve. + + + + + + + + + + + + + + + + This function may be suboptimal for performance for polylines with many points + as List of s + when list is malformed + + + + Returns the values of this as a list of numbers + + A list of values representing the polyline. + + + + Creates a new based on a list of coordinates and the unit they're drawn in. + + The list of values representing this polyline + A new with the provided values. + A Surface in NURBS form. + + + Constructs a new empty + + + + + Constructs a new empty + + The units this surface is modeled in + This surface's unique identifier on a specific application + The degree of the surface in the U direction @@ -1463,9 +1496,6 @@ Determines if the is rational. - - - The raw data of the surface's control points. Use GetControlPoints or SetControlPoints instead of accessing this directly. @@ -1481,9 +1511,6 @@ The number of control points in the V direction - - - The knot vector in the U direction @@ -1520,17 +1547,17 @@ This should be one of - - - Constructs a new empty - + + - - - Constructs a new empty - - The units this surface is modeled in - This surface's unique identifier on a specific application + + + + + + + + @@ -1559,31 +1586,11 @@ The list of values representing this surface A new with the provided values. - - - - - - A 3-dimensional vector - - - Gets or sets the coordinates of the vector - - - - - - - - The unit's this is in. - This should be one of - - @@ -1613,19 +1620,16 @@ The point whose coordinates will be used The unique application ID of the object. - + - Returns the coordinates of this as a list of numbers + Gets or sets the coordinates of the vector - A list of coordinates {x, y, z} - + - Creates a new vector based on a list of coordinates and the unit they're drawn in. + The unit's this is in. + This should be one of - The list of coordinates {x, y, z} - The units the coordinates are in - A new with the provided coordinates. @@ -1642,6 +1646,35 @@ The z coordinate of the vector. + + + Gets the Euclidean length of this vector. + + Length of the vector. + + + + + + + + + + + + + Returns the coordinates of this as a list of numbers + + A list of coordinates {x, y, z} + + + + Creates a new vector based on a list of coordinates and the unit they're drawn in. + + The list of coordinates {x, y, z} + The units the coordinates are in + A new with the provided coordinates. + Divides a vector by a numerical value. This will divide each coordinate by the provided value. @@ -1674,12 +1707,6 @@ The second vector The resulting - - - Gets the Euclidean length of this vector. - - Length of the vector. - Gets the scalar product (dot product) of two given vectors @@ -1716,12 +1743,6 @@ A copy of this vector unitized. - - - - - - Represents an object that has a @@ -1754,7 +1775,7 @@ - Represents + Represents @@ -1816,6 +1837,12 @@ The default Speckle Kit + + + Local installations store objects in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits\Objects + Admin/System-wide installations in C:\ProgramData\Speckle\Kits\Objects + + @@ -1828,12 +1855,6 @@ - - - Local installations store objects in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits\Objects - Admin/System-wide installations in C:\ProgramData\Speckle\Kits\Objects - - @@ -1843,46 +1864,10 @@ - - - A simple container for organising objects within a model and preserving object hierarchy. - A container is defined by a human-readable , a unique , and its list of contained . - The can include an unrestricted number of objects including additional nested s. - - - A can be for example a Layer in Rhino/AutoCad, a collection in Blender, or a Category in Revit. - The location of each collection in the hierarchy of collections in a commit will be retrieved through commit traversal. - - - - - The human-readable name of the . - - This name is not necessarily unique within a commit. Set the applicationId for a unique identifier. - - - - The type of this collection - - - - - The elements contained in this . - - - This can include additional nested s. - - - - - Constructor for a basic collection. - - The human-readable name of this collection - Represents a model from an authoring application and can be used as the root commit object when sending. - It contains and objects + It contains and objects @@ -1966,7 +1951,7 @@ - Block definition class + Block definition class @@ -1982,7 +1967,7 @@ - Dimension class + Dimension class @@ -2012,7 +1997,7 @@ - Curves representing the annotation + Curves representing the annotation @@ -2029,7 +2014,7 @@ Indicates if this dimension is an ordinate dimension - Ordinate dimensions (measuring distance between two points exclusively along the x or y axis) + Ordinate dimensions (measuring distance between two points exclusively along the x or y axis) are in practice drawn with different conventions than linear dimensions, and are treated as a special subset of them. @@ -2108,7 +2093,7 @@ - Block instance class + Block instance class @@ -2165,20 +2150,6 @@ Generic transform class - - - The column-based 4x4 transform matrix - - - Graphics based apps typically use column-based matrices, where the last column defines translation. - Modelling apps may use row-based matrices, where the last row defines translation. Transpose if so. - - - - - Units for translation - - Construct a transform from a row-based double array of size 16 @@ -2211,6 +2182,20 @@ + + + The column-based 4x4 transform matrix + + + Graphics based apps typically use column-based matrices, where the last column defines translation. + Modelling apps may use row-based matrices, where the last row defines translation. Transpose if so. + + + + + Units for translation + + Decomposes matrix into its scaling, rotation, and translation components @@ -2304,12 +2289,7 @@ - Codes and standards references, model units, design settings, analysis settings, precision and tolerances - - - - - Units object containing units information for key structural model quantities + Codes and standards references, model units, design settings, analysis settings, precision and tolerances @@ -2321,6 +2301,11 @@ + + + Units object containing units information for key structural model quantities + + SchemaBuilder constructor for structural 1D element (based on local axis) @@ -2400,7 +2385,7 @@ - A generalised structural load, described by a name and load case + A generalised structural load, described by a name and load case Name of the load Load case specification for the load @@ -2436,7 +2421,7 @@ A structural load case, a load case gives a way of grouping load effects together - + The name of the load case (the names of individual loads that are associated with the load case are defined elsewhere, in the loads themselves) The type of the load case A way of grouping load cases with the similar characteristics (ex. the source/mass source/origin of the loads) @@ -2444,18 +2429,18 @@ A description of the load case - + - - - - - + + + + + A face load (for 2D elements) - + The load case in which the load applies A list of 2D elements to apply the load to The type of loading applied @@ -2469,7 +2454,7 @@ A face load (for 2D elements) with a user-defined axis - + The load case in which the load applies A list of 2D elements to apply the load to The type of loading applied @@ -2515,7 +2500,7 @@ >A list of nodes to apply the load to The direction of the loading, relative to the specified axis The magnitude of the load, either a force or moment - A name or description to identify the load/// + A name or description to identify the load/// @@ -2526,7 +2511,7 @@ The axis in which the load is applied The direction of the loading, relative to the specified axis The magnitude of the load, either a force or moment - A name or description to identify the load/// + A name or description to identify the load/// diff --git a/Packages/systems.speckle.speckle-unity/package.json b/Packages/systems.speckle.speckle-unity/package.json index 1aa2be8..c5a9ffe 100644 --- a/Packages/systems.speckle.speckle-unity/package.json +++ b/Packages/systems.speckle.speckle-unity/package.json @@ -1,6 +1,6 @@ { "name": "systems.speckle.speckle-unity", - "version": "2.13.0", + "version": "2.14.2", "displayName": "Speckle Unity Connector", "description": "AEC Interoperability for Unity through Speckle", "unity": "2018.4",