Component:PhotoMetadata: Difference between revisions

From Resonite Wiki
← Older edit
Visual
fill in some descriptions for the component values
add sync delegate desc
 
(12 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=PhotoMetadataComponent.png
|Image=PhotoMetadataComponent.png
|Name=Photo Metadata
|Name=Photo Metadata
}}
}}
The '''PhotoMetadata''' component is used to contain the information on a photo usually taken within Resonite. It is automatically attached to every screenshot taken using the finger photo gesture. This component can also be attached to a photo imported with the "import as screenshot" option when importing an image.


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|LocationName|String|Name of the session the screenshot was taken in.
|LocationName|String|Name of the session the screenshot was taken in.
|LocationURL|Uri|
|LocationURL|Uri| The URI of the session's world that the photo was taken in. (basically a world link)
|User|User|Host of the session the screenshot was taken in.
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|Host of the session the screenshot was taken in.
|_machineId|String|Machine ID of the host.
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:SessionAccessLevel|SessionAccessLevel]]&gt;'''|TypeAdv3=true|Access level of the session.
|_userId|String|User ID of the host.
|LocationHiddenFromListing|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv4=true|Whether the location was marked as hidden.
|LocationAccessLevel|Nullable`1|TypeString3=Nullable<SessionAccessLevel>|Access level of the session.
|LocationHiddenFromListing|Nullable`1|TypeString4=Bool?|Whether the location was marked as hidden.
|TimeTaken|DateTime|Exact timestamp that the screenshot was taken.
|TimeTaken|DateTime|Exact timestamp that the screenshot was taken.
|User|User|User who took the screenshot.
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|User who took the screenshot.
|_machineId|String|Machine ID of the photographer.
|TakenGlobalPosition|Float3| The position in [[Coordinate spaces|global space]] the camera had when the photo was taken.
|_userId|String|User ID of the photographer.
|TakenGlobalRotation|FloatQ| The rotation in  [[Coordinate spaces|global space]] the camera had when the photo was taken.
|TakenGlobalScale|Float3| The scale in [[Coordinate spaces|global space]] the camera had when the photo was taken.
|AppVersion|String|Resonite version number of the photographer.
|AppVersion|String|Resonite version number of the photographer.
|PresentUsers|SyncList`1|TypeString8=SyncList<UserRef>|List of users within the session.
|UserInfos|{{RootFieldType|SyncList`1|[[Component:AssetMetadata#UserInfo|AssetMetadata.UserInfo]]}}|TypeAdv11=true| See [[Type:UserInfo|UserInfo]]
|__legacyPresentUsers|{{RootFieldType|SyncList`1|[[Type:UserRef|UserRef]]}}|TypeAdv12=true| Internal. no longer used.
|CameraManufacturer|String|Manufacturer of the camera.
|CameraManufacturer|String|Manufacturer of the camera.
|CameraModel|String|Model of the camera.
|CameraModel|String|Model of the camera.
|CameraFOV|Float|FOV of the camera at picture time.
|CameraFOV|Float|FOV of the camera at picture time.
|Is360|Bool|Whether the image is a 360 degree image or not.
|Is360|Bool|Whether the image is a 360 degree image or not.
|StereoLayout|StereoLayout|
|StereoLayout|StereoLayout| The layout of the image's left and right sections if it is a stereoscopic image, also known as a 3D image.
|_exportedUsers|SyncBag`1|TypeString14=SyncBag<UserRef>|
|_exportedUsers|{{RootFieldType|SyncBag`1|[[Type:UserRef|UserRef]]}}|TypeAdv18=true| This is a list of users that exported the screenshot. If this component is part of a saved item, this is the list of users that exported the screenshot before the item was saved to the cloud.
}}
}}


<!--T:3-->
== Sync Delegates ==
== Usage ==
{{Table ComponentTriggers
|OnSavePhoto:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the save photo button is touched.
|OnExportPhoto:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the export photo button is touched.
|SetFromCurrentWorld:[[Type:Action|Action]]|[[Type:Action|Action]]|false| {{Template:AssetMetadataSetFromWorld}}
}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
<gallery widths=480px heights=480px>
File:Component_AssetMetadata_Example_1.webp|The PhotoMetadata component on a screenshot.
</gallery>


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:FileMetadata]]
* [[Component:AssetMetadata]]
* [[Component:AudioMetadata]]
 
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Photo Metadata]]
[[Category:Components{{#translation:}}|Photo Metadata]]
[[Category:Components:Data{{#translation:}}|Photo Metadata]]
[[Category:Components:Data{{#translation:}}|Photo Metadata]]

Latest revision as of 21:23, 7 April 2025

Component image 
Photo Metadata component as seen in the Scene Inspector

The PhotoMetadata component is used to contain the information on a photo usually taken within Resonite. It is automatically attached to every screenshot taken using the finger photo gesture. This component can also be attached to a photo imported with the "import as screenshot" option when importing an image.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
LocationName String Name of the session the screenshot was taken in.
LocationURL Uri The URI of the session's world that the photo was taken in. (basically a world link)
LocationHost direct UserRef Host of the session the screenshot was taken in.
LocationAccessLevel Nullable`1<SessionAccessLevel> Access level of the session.
LocationHiddenFromListing Nullable`1<Bool> Whether the location was marked as hidden.
TimeTaken DateTime Exact timestamp that the screenshot was taken.
TakenBy direct UserRef User who took the screenshot.
TakenGlobalPosition Float3 The position in global space the camera had when the photo was taken.
TakenGlobalRotation FloatQ The rotation in global space the camera had when the photo was taken.
TakenGlobalScale Float3 The scale in global space the camera had when the photo was taken.
AppVersion String Resonite version number of the photographer.
UserInfos list of AssetMetadata.UserInfo See UserInfo
__legacyPresentUsers list of UserRef Internal. no longer used.
CameraManufacturer String Manufacturer of the camera.
CameraModel String Model of the camera.
CameraFOV Float FOV of the camera at picture time.
Is360 Bool Whether the image is a 360 degree image or not.
StereoLayout StereoLayout The layout of the image's left and right sections if it is a stereoscopic image, also known as a 3D image.
_exportedUsers unordered list of UserRef This is a list of users that exported the screenshot. If this component is part of a saved item, this is the list of users that exported the screenshot before the item was saved to the cloud.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnSavePhoto:ButtonEventHandler ButtonEventHandler ✓ Called when the save photo button is touched.
OnExportPhoto:ButtonEventHandler ButtonEventHandler ✓ Called when the export photo button is touched.
SetFromCurrentWorld:Action Action X fills in all the fields using the current session data and the local user (the user running this method)

Examples

  • The PhotoMetadata component on a screenshot.
    The PhotoMetadata component on a screenshot.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:PhotoMetadata&oldid=99086"