Funciones de gestión de contenido 3D
setViewProperties
Configura las opciones de fotorrealismo en la vista.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene las propiedades de la vista que se va a configurar.
|
Obligatorio
|
|
|
params.dropshadow
|
Boolean
|
Activa o desactiva la sombra paralela.
|
Opcional
|
true
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
 |
Actualmente, la sombra paralela solo se soporta en el objeto params.
|
addPVS
Añade un modelo 3D a la experiencia.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
trackerName
|
String
|
ID de rastreador con el que debe asociarse este modelo.
|
Obligatorio
|
|
name
|
String
|
ID de estudio del widget de Modelo.
|
Obligatorio
|
|
url
|
String
|
URI para cargar el modelo 3D.
|
Opcional
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
Si url se deja vacío o sin definir, se creará un marcador de modelo vacío.
|
setModelURL
Define un nuevo URL para un modelo y carga el modelo.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene la referencia del modelo y el URI.
|
Obligatorio
|
|
params.modelID
|
String
|
ID de Studio del elemento del modelo que se va a actualizar.
|
Obligatorio
|
|
params.modelURL
|
String
|
URI desde el que cargar el modelo 3D.
|
Obligatorio
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
El elemento del modelo debe inicializarse de antemano con addPVS.
|
setProperties
Define propiedades de efectos visuales y de fotorrealismo de un determinado elemento.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
name
|
String
|
ID de Studio del elemento que se va a actualizar.
|
Obligatorio
|
|
|
params
|
Objeto
|
Objeto que contiene las propiedades de fotorrealismo que se va a aplicar.
|
Obligatorio
|
|
|
params.occlude
|
Boolean
|
Activa o desactiva la oclusión del modelo de otros objetos.
|
Opcional
|
true
|
|
params.billboard
|
Boolean
|
Activa o desactiva la creación de carteles (solo se aplica a los widgets del tipo Imagen 3D (Imagen 3D, Indicador 3D y Etiqueta 3D).
|
Opcional
|
true
|
|
params.hidden
|
Boolean
|
Activa o desactiva la ocultación del elemento (se aplica a todos los widgets que no son del modelo 3D; principalmente, subconjuntos).
|
Opcional
|
true
|
|
params.opacity
|
Número
|
Define la opacidad del elemento (0.0 = transparente, 1.0 = opaco).
|
Opcional
|
1.0
|
|
params.decal
|
Boolean
|
Activa o desactiva el modo de fotorrealismo de calcomanías/siempre arriba.
|
Opcional
|
true
|
|
params.shader
|
String
|
Cadena de definición del sombreador compuesta por el nombre del sombreador y parámetros opcionales; separada por puntos y coma. Ejemplo: "highlight; r f 1; g f 0; b f 0; a f 1"
|
Opcional
|
""
|
|
params.phantom
|
Boolean
|
Activa o desactiva la semitransparencia del elemento (solo se aplica a los widgets Modelo 3D).
|
Opcional
|
true
|
|
params.forceHidden
|
Boolean
|
Activa o desactiva la ocultación forzada del elemento (solo se aplica a los widgets Modelo 3D).
|
Opcional
|
true
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Puede aplicar varias propiedades a la vez combinándolas en el objeto params.
• Las propiedades que no se especifiquen se definirán según sus valores por defecto.
|
loadPVI
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene la referencia del modelo y el URI del fichero PVI.
|
Obligatorio
|
|
params.modelID
|
String
|
ID de Studio del modelo en el que se va a cargar el fichero PVI.
|
Obligatorio
|
|
params.url
|
String
|
URI del fichero PVI utilizado para cargar datos de animación. Si se omite, se descargarán los datos de animación previamente cargados para el modelo.
|
Obligatorio
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Si se proporciona el URL, la animación se carga desde el fichero especificado.
• Si se omite el URL o es una cadena vacía, se quitarán del modelo todos los datos de PVI cargados previamente.
|
playStep
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene información sobre el modelo y los pasos.
|
Obligatorio
|
|
params.modelID
|
String
|
ID de Studio del modelo para el que se reproducirá el paso de animación.
|
Obligatorio
|
|
params.stepNumber
|
Número
|
Número de paso que ejecutar.
|
Obligatorio
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
El modelo debe tener un fichero PVI cargado con pasos de animación válidos (consulte loadPVI).
|
gotoStep
Salta a un determinado paso de animación del modelo indicado y lo define en la posición dada.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene información sobre el modelo y los pasos.
|
Obligatorio
|
|
params.modelID
|
String
|
ID de Studio del modelo para el que se reproducirá el paso de animación.
|
Obligatorio
|
|
params.stepNumber
|
Número
|
Número de paso al que ir.
|
Obligatorio
|
|
params.position
|
String
|
Posición dentro del paso: inicio o fin.
|
Obligatorio
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
Requiere que el modelo tenga cargados datos de animación de PVI (consulte loadPVI).
|
add3DImage
Añade una imagen en el espacio 3D.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene información sobre la posición y la visualización de la imagen.
|
Obligatorio
|
|
|
params.tracker
|
String
|
ID de rastreador con el que debe asociarse esta imagen.
|
Obligatorio
|
|
|
params.id
|
String
|
ID de Studio del widget.
|
Obligatorio
|
|
|
params.src
|
String
|
URI o cadena Base64 de la imagen que se va a mostrar.
|
Obligatorio
|
|
|
params.width
|
Número
|
Ancho de la imagen en espacio 3D (en metros).
|
Opcional
|
NaN
|
|
params.height
|
Número
|
Altura de la imagen en espacio 3D (en metros).
|
Opcional
|
NaN
|
|
params.pivot
|
Número
|
Punto de giro para posicionar. Estos son los valores de giro:
• 1: giro en la esquina superior izquierda
• 2: giro en la parte central superior
• 3: giro en la esquina superior derecha
• 4: giro en la arista central izquierda
• 5: giro en el centro (por defecto)
• 6: giro en la arista central derecha
• 7: giro en la esquina inferior izquierda
• 8: giro en la parte central inferior
• 9: giro en la esquina inferior derecha
|
Opcional
|
5
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Si el ancho o la altura se omiten o se definen como NaN, el valor que falte se calculará según la otra cota proporcionada y se conserva la proporción dimensional original.
• Si el ancho y la altura se omiten o se definen en NaN, las cotas se determinarán automáticamente a partir del tamaño original de la imagen.
|
setWayfinderProperties
Define las propiedades de un widget del Buscador de recorridos. Requiere setWaypoint para que se llame después de iniciar la navegación.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene opciones de configuración del Buscador de recorridos.
|
Obligatorio
|
|
|
params.widgetId
|
String
|
ID de Studio del widget del Buscador de recorridos que se va a configurar.
|
Obligatorio
|
|
|
params.active
|
Boolean
|
Activa o desactiva el Buscador de recorridos.
|
Opcional
|
true
|
|
params.showReticle
|
Boolean
|
Activa o desactiva la visualización de la retícula.
|
Opcional
|
true
|
|
params.showRibbon
|
Boolean
|
Activa o desactiva la visualización de la ruta de la cinta que conduce a un punto de recorrido.
|
Opcional
|
true
|
|
params.showWaypoints
|
Boolean
|
Activa o desactiva la visualización de puntos de recorrido.
|
Opcional
|
true
|
|
params.showLabels
|
Boolean
|
Activa o desactiva la visualización de etiquetas de puntos de recorrido.
|
Opcional
|
true
|
|
params.labelsOnTop
|
Boolean
|
Activa o desactiva el fotorrealismo de etiquetas sobre otros elementos de la escena.
|
Opcional
|
true
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
setWaypoint
Define o actualiza las propiedades del punto de recorrido activo, incluidos la posición y el aspecto visual. Requiere una llamada anterior a setWayfinderProperties.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene la configuración del punto de recorrido.
|
Obligatorio
|
|
|
params.position
|
String
|
Posición 3D del punto de recorrido como objeto con propiedades x, y, z. Por ejemplo:{"x": 0.1995, "y": 0.0617, "z": 0.2545}
|
Obligatorio
|
|
|
params.gaze
|
String
|
Vector de dirección de la mirada 3D como objeto con propiedades x, y, z. Por ejemplo:{"x": 0, "y": 0, "z": -1}
|
Obligatorio
|
|
|
params.eventRadius
|
Número
|
Distancia (en metros) a la que se activan los eventos (por ejemplo, el avance automático).
|
Opcional
|
0
|
|
params.wayfinderDisplayBoundary
|
Número
|
Radio (en metros) dentro del cual se oculta el Buscador de recorridos.
|
Opcional
|
0
|
|
params.color
|
String
|
El color del punto de recorrido y de la cinta. Debe ser uno de los siguientes valores rgba predefinidos: naranja, rojo, verde, azul, amarillo, rosa, cyan, negro, blanco. Cualquier color no soportado será naranja por defecto. Ejemplo: "rgba(255, 165, 0, 1)"). Estos son los valores soportados:
• Naranja: rgba(255, 165, 0, 1)
• Rojo: rgba(255, 0, 0, 1)
• Verde: rgba(0, 255, 0, 1)
• Azul: rgba(0, 0, 255, 1)
• Amarillo: rgba(255, 255, 0, 1)
• Rosa: rgba(255, 0, 255, 1)
• Cyan: rgba(0, 255, 255, 1)
• Negro: rgba(0, 0, 0, 1)
• Blanco: rgba(255, 255, 255, 1)
Si se pasa cualquier otro color, automáticamente se utiliza el color por defecto naranja: rgba(255, 165, 0, 1).
|
Opcional
|
black
|
|
params.label
|
String
|
Etiqueta de texto que se va a mostrar junto al punto de recorrido.
|
Opcional
|
""
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
Los parámetros de posición y mirada deben ser objetos de vector 3D (por ejemplo, {"x": 0.1995, "y": 0.0617, "z": 0.2545}).
|