Frame Handle

class huira.visible8.FrameHandle
__init__(*args, **kwargs)
delete_instance(self: huira._huira.visible8.FrameHandle, instance: huira._huira.visible8.InstanceHandle) → None
delete_subframe(self: huira._huira.visible8.FrameHandle, subframe: huira._huira.visible8.FrameHandle) → None
get_parent(self: huira._huira.visible8.FrameHandle) → huira::NodeHandle<huira::SpectralBins<8ul, 380, 750>, huira::Node<huira::SpectralBins<8ul, 380, 750> > >
get_spice_frame(self: huira._huira.visible8.FrameHandle) → str
get_spice_origin(self: huira._huira.visible8.FrameHandle) → str
get_static_angular_velocity(self: huira._huira.visible8.FrameHandle) → huira._huira.Vec3
get_static_position(self: huira._huira.visible8.FrameHandle) → huira._huira.Vec3
get_static_rotation(self: huira._huira.visible8.FrameHandle) → huira._huira.Rotation
get_static_scale(self: huira._huira.visible8.FrameHandle) → huira._huira.Vec3
get_static_velocity(self: huira._huira.visible8.FrameHandle) → huira._huira.Vec3
id(self: huira._huira.visible8.FrameHandle) → int
is_effectively_visible(self: huira._huira.visible8.FrameHandle) → bool

True only when this node and every one of its ancestors are visible

is_visible(self: huira._huira.visible8.FrameHandle) → bool

This node’s own flag, which ignores whether an ancestor is hidden

name(self: huira._huira.visible8.FrameHandle) → str
new_instance(*args, **kwargs)

Overloaded function.

  1. new_instance(self: huira._huira.visible8.FrameHandle, asset_handle: huira._huira.visible8.CameraModelHandle) -> huira._huira.visible8.InstanceHandle

  2. new_instance(self: huira._huira.visible8.FrameHandle, asset_handle: huira._huira.visible8.LightHandle) -> huira._huira.visible8.InstanceHandle

  3. new_instance(self: huira._huira.visible8.FrameHandle, asset_handle: huira._huira.visible8.UnresolvedObjectHandle) -> huira._huira.visible8.InstanceHandle

  4. new_instance(self: huira._huira.visible8.FrameHandle, asset_handle: huira._huira.visible8.ModelHandle) -> huira._huira.visible8.InstanceHandle

  5. new_instance(self: huira._huira.visible8.FrameHandle, asset_handle: huira._huira.visible8.PrimitiveHandle) -> huira._huira.visible8.InstanceHandle

new_spice_subframe(self: huira._huira.visible8.FrameHandle, spice_origin: str, spice_frame: str) → huira._huira.visible8.FrameHandle
new_subframe(self: huira._huira.visible8.FrameHandle) → huira._huira.visible8.FrameHandle
set_angular_velocity(self: huira._huira.visible8.FrameHandle, wx: object, wy: object, wz: object) → None

Set the angular velocity expressed in the PARENT frame’s axes (accepts any angular velocity unit). The orientation evolves as q(t) = delta(t) * q_0; this is only an ‘inertial’ rate if every ancestor of the node is static. To command rates about the node’s own axes (e.g. a roll about a camera boresight), use set_body_angular_velocity() instead.

set_body_angular_velocity(self: huira._huira.visible8.FrameHandle, wx: object, wy: object, wz: object) → None

Set the angular velocity expressed in the node’s own BODY frame axes (accepts any angular velocity unit). The orientation evolves as q(t) = q_0 * delta(t). For a camera (OpenCV convention, +z = boresight), a pure wz produces a roll about the boresight regardless of the camera’s orientation relative to its parent. To command rates in the parent frame’s axes, use set_angular_velocity() instead.

set_euler_angles(self: huira._huira.visible8.FrameHandle, x: object, y: object, z: object, sequence: str = 'XYZ') → None
set_position(self: huira._huira.visible8.FrameHandle, x: object, y: object, z: object) → None

Set position (accepts any distance unit)

set_rotation(self: huira._huira.visible8.FrameHandle, rotation: huira._huira.Rotation) → None
set_rotation_local_to_parent(*args, **kwargs)

Overloaded function.

  1. set_rotation_local_to_parent(self: huira._huira.visible8.FrameHandle, matrix: huira._huira.Mat3) -> None

  2. set_rotation_local_to_parent(self: huira._huira.visible8.FrameHandle, quaternion: huira._huira.Quaternion) -> None

  3. set_rotation_local_to_parent(self: huira._huira.visible8.FrameHandle, axis: huira._huira.Vec3, angle: object) -> None

set_rotation_parent_to_local(*args, **kwargs)

Overloaded function.

  1. set_rotation_parent_to_local(self: huira._huira.visible8.FrameHandle, matrix: huira._huira.Mat3) -> None

  2. set_rotation_parent_to_local(self: huira._huira.visible8.FrameHandle, quaternion: huira._huira.Quaternion) -> None

  3. set_rotation_parent_to_local(self: huira._huira.visible8.FrameHandle, axis: huira._huira.Vec3, angle: object) -> None

set_scale(*args, **kwargs)

Overloaded function.

  1. set_scale(self: huira._huira.visible8.FrameHandle, sx: float, sy: float, sz: float) -> None

  2. set_scale(self: huira._huira.visible8.FrameHandle, s: float) -> None

set_spice(self: huira._huira.visible8.FrameHandle, spice_origin: str, spice_frame: str) → None
set_spice_frame(self: huira._huira.visible8.FrameHandle, spice_frame: str) → None
set_spice_origin(self: huira._huira.visible8.FrameHandle, spice_origin: str) → None
set_velocity(self: huira._huira.visible8.FrameHandle, vx: object, vy: object, vz: object) → None

Set velocity (accepts any velocity unit)

set_visible(self: huira._huira.visible8.FrameHandle, visible: bool = True) → None

Set whether this node is collected into a SceneView.

Read when a SceneView is constructed, so a SceneView that already exists is unaffected; build a new one to render the change. Descendants are skipped along with this node but keep their own flags, so showing it again restores whatever each descendant was individually set to. Hiding a light removes its illumination as well as its appearance.

type(self: huira._huira.visible8.FrameHandle) → str
valid(self: huira._huira.visible8.FrameHandle) → bool