gradio-model3dgscamera

---

tags: [gradio-custom-component, Model3D] title: gradio_model3dgscamera short_description: 3DGS viewer with camera control colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: app.py

gradio_model3dgscamera

3DGS viewer with camera control

Installation

pip install gradio_model3dgscamera

Usage

import gradio as gr
from gradio_model3dgscamera import Model3DGSCamera

with gr.Blocks() as demo:
    file = gr.File()
    with gr.Row():
        kwargs = dict(
            width=512,
            height=512,
            camera_width=512,
            camera_height=512,
            camera_fx=491.52,
            camera_fy=491.52,
            camera_near=0.01,
            camera_far=100
        )
        viewer = Model3DGSCamera(**kwargs)
        viewer2 = Model3DGSCamera(**kwargs)
    button = gr.Button(value='Get camera pose')

    def set_viewer(file):
        return file, (0, 0, -4.6804), None

    file.upload(set_viewer, file, viewer)
    button.click(lambda x: x, viewer, viewer2)

if __name__ == "__main__":
    demo.launch()

Model3DGSCamera

Initialization

name	type	default	description
value	str | Callable | None	None	path to (.obj, .glb, .stl, .gltf, .splat, or .ply) file to show in Model3DGSCamera viewer. If callable, the function will be called whenever the app loads to set the initial value of the component.
height	int | str | None	None	The height of the Model3DGSCamera component, specified in pixels if a number is passed, or in CSS units if a string is passed.
width	int | str | None	None	The width of the Model3DGSCamera component, specified in pixels if a number is passed, or in CSS units if a string is passed.
camera_width	int | None	None	The width of camera in pixels.
camera_height	int | None	None	The height of camera in pixels.
camera_fx	float | None	None	The camera focal length.
camera_fy	float | None	None	The camera focal length.
camera_near	float | None	None	The camera near clip distance.
camera_far	float | None	None	The camera far clip distance.
label	str | None	None	The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
show_label	bool | None	None	if True, will display label.
every	Timer | float | None	None	Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
inputs	Component | Sequence[Component] | set[Component] | None	None	Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
container	bool	True	If True, will place the component in a container - providing some extra padding around the border.
scale	int | None	None	relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.
min_width	int	160	minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
interactive	bool | None	None	if True, will allow users to upload a file; if False, can only be used to display files. If not provided, this is inferred based on whether the component is used as an input or output.
visible	bool	True	If False, component will be hidden.
elem_id	str | None	None	An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes	list[str] | str | None	None	An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
render	bool	True	If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
key	int | str | None	None	if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.

Events

name	description
change	Triggered when the value of the Model3DGSCamera changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.
clear	This listener is triggered when the user clears the Model3DGSCamera using the X button for the component.

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

• When used as an Input, the component only impacts the input signature of the user function.
• When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

• As output: Is passed, the preprocessed input data sent to the user's function in the backend.
• As input: Should return, the output data received by the component from the user's function in the backend.

def predict(
    value: tuple[
   str | pathlib.Path | None,
   tuple[float, float, float] | None,
   tuple[float, float, float] | None,
]
) -> str
   | pathlib.Path
   | None
   | tuple[
       str | pathlib.Path,
       tuple[float, float, float] | None,
       tuple[float, float, float] | None,
   ]:
    return value

Model3DGSCameraData

Initialization

name	type	default	description