StaticBuildOptionaloptions: IManifestoOptionsOptionaljsonld: anyOptionaloptions: IManifestoOptionsFar plane value of the camera. +*
+Full angular size of perspective viewport in vertical direction. +Angular unit is degrees +*
+Near plane value of the camera. +*
+the far plane value, i.e. the maximum distance from the camera at +which something in the space must exist in order to be viewed by the camera. +*
+full angular size of perspective viewport in vertical direction. +Angular unit is degrees +*
+returns the PropertyValue which in turn allows a language-specific string +encoded in the json as the "label" property
+: if not null, is either a PointSelector, an object +with an id matching the id of an Annotation instance, or a +SpecificResource with a PointSelector .
+the near plane value, i.e. the minimum distance from the camera at +which something in the space must exist in order to be viewed by the camera. +*
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+full linear size of orthographic viewport in vertical direction. +linear unit is Scene global unit of measure
+Name of this property was originally Height, has been changed +at this revision to ViewHeight: +See issues at https://github.com/IIIF/api/issues/2289 +*
+class structure with red, green, blue values in 0-255 range +Uses the color-string +library for conversion from and to string representations of color.
+Array of three 0-255 integers for r,g,b value. Ex: [255.0,0] for red
+0 to 255 value of blue color component
+hex string (as for CSS ) representation of r,g,b components
+0 to 255 value of green color component
+0 to 255 value of red color component
+OptionalcompareFn: ((a: Language, b: Language) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
-[11,2,22,1].sort((a, b) => a - b)
+value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.
+[11,2,22,1].sort((a, b) => a - b)
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
diff --git a/docs/classes/Light.html b/docs/classes/Light.html new file mode 100644 index 00000000..c422a22a --- /dev/null +++ b/docs/classes/Light.html @@ -0,0 +1,98 @@ +With the 3D extensions to the IIIF Presentation API the name of this +class is misleading, but for now is being retained for the sake backward +compatibility with earlier manifesto code and tests.
+The 3D extensions allow that the body property of an annotation can be +a light, camera, or model, or a SpecificResource object wrapping a light, camera, +or model. +*
+Optionaljsonld: anyOptionaloptions: IManifestoOptionsAs defined in the temp-draft-4.md ( +https://github.com/IIIF/3d/blob/main/temp-draft-4.md#lights ; 12 May 2024) +this quantity is the half-angle of the cone of the spotlight.
+The inconsistency between this definition of the angle and the definition of +fieldOfView for PerspectiveCamera (where the property value defines the full angle) has +already been noted: https://github.com/IIIF/api/issues/2284
+provisional decision is to return undefined in case that this property +is accessed in a light that is not a spotlight
+number
+The implementation of the intensity is based on +temp-draft-4.md +and the example 3D manifests +lights +on 24 Mar 2024. The intensity property in the manifest is an object +with declared type 'Value', a numeric property named 'value' and a +property named unit . This implementation will only work with a unit == 'relative' +and it will be assumed that a relative unit value of 1.0 corresponds to the +brightest light source a rendering engine supports.
+This code will implement a default intensity of 1.0
+returns the PropertyValue which in turn allows a language-specific string +encoded in the json as the "label" property
+: if not null, is either a PointSelector, or an object +with an id matching the id of an Annotation instance.
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+the 3D coordinates of the point as a Vector3 instance. +*
+the 3D coordinates of the point as a Vector3 instance. +*
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+OptionalcompareFn: ((a: LocalizedValue, b: LocalizedValue) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
-[11,2,22,1].sort((a, b) => a - b)
+value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.
+[11,2,22,1].sort((a, b) => a - b)
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
diff --git a/docs/classes/RotateTransform.html b/docs/classes/RotateTransform.html new file mode 100644 index 00000000..ab72f7c6 --- /dev/null +++ b/docs/classes/RotateTransform.html @@ -0,0 +1,31 @@ +Optionaljsonld: anyaccessor Rotation is an object with x,y,z attributes whose values are +a counter-clockwise rotation in degrees about the fixed coordinate +system axes.
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+Returns an object with x,y,z attributes whose values are +a counter-clockwise rotation in degrees about the fixed coordinate +system axes.
+object
+Optionaljsonld: anyA function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+returns the PropertyValue which in turn allows a language-specific string +encoded in the json as the "label" property
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+Developer note: This implementation does not strictly adhere +to the description of SpecificResource in the Web Annotation Model +document https://www.w3.org/TR/annotation-model/ +section 4 : https://www.w3.org/TR/annotation-model/#specific-resources
+The getTransform() method returning an Array of 3D Transfom resources, is +an extension of SpecificResource beyond the web annotation model.
+Optionaloptions: IManifestoOptionsreturns the PropertyValue which in turn allows a language-specific string +encoded in the json as the "label" property
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+An implementation of the TextualBody class (class in JSON-LD sense) +as it is described in Web Annotation Data Model Section 3.2.4 +https://www.w3.org/TR/annotation-model/#embedded-textual-body +*
+Optionaljsonld: anyOptionaloptions: IManifestoOptionsThe simple string that is the data content of this resource +will return empty string as a default value +*
+returns the PropertyValue which in turn allows a language-specific string +encoded in the json as the "label" property
+Returns a specific resource representing the TextualBody position if +present, otherwise null. +*
+A function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+AbstractOptionaljsonld: anyA function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+Optionaljsonld: anyA function that wraps the getProperty function, which client +code can use if it is needed to identify when the json value of +a property is an IRI -- Internationalized Resource Identifier
+If the value of the json value is a bare string, then it will be +wrapped in a json object with the string in the property 'id', +additionally that property will have a property 'isIRI' which will +be true for the literal string case, otherwise false meaning the +returned getProperty should be parsed as before.
+performs the calculation required for the lookAt +property of a camera resource. Determines the +required angles of two rotations, the first about +the x axis and the second about the y axis, which will +rotate the default camera direction (0,0,-1) into the +direction of the input arguments
+Result of calculation is returned as a instance of EulerAngle from the +threejs-math library. The "axes order" of the EulerAngle is "YXZ": The +three-js library uses body-fixed axes to represent EulerAngles, which reverse +the ordering of the "relative rotation" algorithm described in the +draft 3d api.
+A vector interpreted as a direction. Client code +responsible for not passing a 0-length vector, else a
+threejs-math.EulerAngle instance
+Given an array of Transform instances, returns a single Matrix4 +instance that represents the cumulative effect of the transforms +in the order they appear in the array.
+An array of Transform instances
+A Matrix4 instance representing the cumulative effect of the transforms
+Implements the convention that the 3 component values for the RotateTranform +cass (properties x,y,z) are to be interpreted as Euler angles in the intrinsic XYZ +order
+: A object with a Rotation member object, properties x,y,z
+threejs-math.EulerAngle instance. From this threejs-math functionsa +allow conversion to other rotation representations.
+Evaluates the rotation required to transform a directional light +or spot ling, which in iiif 3D spec +have an initial direction in the -Y direction, to a direction +along the input argument
+TODO : expand on this documentation taking into account the +implied specification that RotateTransform instances +are to be interpreted as an Euler angle definition of +the rotation
+A vector interpreted as a direction. Client code +responsible for not passing a 0-length vector, else a
+threejs-math.EulerAngle instance
+
With the 3D extensions to the IIIF Presentation API the name of this +class is misleading, but for now is being retained for the sake backward +compatibility with earlier manifesto code and tests.
+The 3D extensions allow that the body property of an annotation can be +a light, camera, or model, or a SpecificResource object wrapping a light, camera, +or model. +*
+