cloudViewer.geometry.ccDrawableObject

class cloudViewer.geometry.ccDrawableObject

The Generic interface for (3D) drawable entities.

__init__(*args, **kwargs)

colors_shown(self)

Returns whether colors are shown or not.

Returns:

bool

enable_gl_transformation(self, state)

Enables/disables associated GL transformation.

Parameters:

state (bool) –

Returns:

None

enable_temp_color(self, state)

Set temporary color activation state.

Parameters:

state (bool) –

Returns:

None

get_gl_transformation(self)

Returns associated GL transformation.

Returns:

typing.Annotated[numpy.typing.NDArray[numpy.float32], “[4, 4]”]

get_opacity(self)

Get opacity.

Returns:

float

get_temp_color(self)

Returns current temporary (unique) color.

Returns:

typing.Annotated[numpy.typing.NDArray[numpy.float64], “[3, 1]”]

has_colors(self)

Returns whether colors are enabled or not.

Returns:

bool

has_displayed_scalar_field(self)

Returns whether an active scalar field is available or not.

Returns:

bool

has_normals(self)

Returns whether normals are enabled or not.

Returns:

bool

has_scalar_fields(self)

Returns whether one or more scalar fields are instantiated.

Returns:

bool

is_color_overriden(self)

Returns whether colors are currently overridden by a temporary (unique) color.

Returns:

bool

is_gl_trans_enabled(self)

Returns whether a GL transformation is enabled or not.

Returns:

bool

is_selected(self)

Returns whether entity is selected or not.

Returns:

bool

is_visible(self)

Returns whether entity is visible or not.

Returns:

bool

is_visiblity_locked(self)

Returns whether visibility is locked or not.

Returns:

bool

lock_visibility(self, state)

Locks/unlocks visibility.

Parameters:

state (bool) –

Returns:

None

name_3d_shown(self)

Returns whether name is displayed in 3D or not.

Returns:

bool

normals_shown(self)

Returns whether normals are shown or not.

Returns:

bool

reset_gl_transformation(self)

Resets associated GL transformation.

Returns:

None

rotate_gl(self, rotation)

Multiplies (left) current GL transformation by a rotation matrix.

Parameters:

rotation (Annotated[numpy.typing.ArrayLike, numpy.float64,) –

Returns:

None

set_gl_transformation(self, transformation)

Associates entity with a GL transformation (rotation + translation).

Parameters:

transformation (Annotated[numpy.typing.ArrayLike, numpy.float64,) –

Returns:

None

set_opacity(self, opacity)

Set opacity activation state.

Parameters:

opacity (SupportsFloat) –

Returns:

None

set_selected(self, state)

Selects/Unselects entity.

Parameters:

state (bool) –

Returns:

None

set_temp_color(self, color, auto_activate=True)

Sets current temporary (unique).

Parameters:

• color (Annotated[numpy.typing.ArrayLike, numpy.float64,) – rgb color

• auto_activate (bool, optional, default=True) – auto activates temporary color

Returns:

None

set_visible(self, state)

Sets entity visibility.

Parameters:

state (bool) –

Returns:

None

sf_shown(self)

Returns whether active scalar field is visible.

Returns:

bool

show_3d_name(self, state)

Sets whether name should be displayed in 3D.

Parameters:

state (bool) –

Returns:

None

show_colors(self, state)

Sets colors visibility.

Parameters:

state (bool) –

Returns:

None

show_normals(self, state)

Sets normals visibility.

Parameters:

state (bool) –

Returns:

None

show_sf(self, state)

Sets active scalar field visibility.

Parameters:

state (bool) –

Returns:

None

toggle_colors(self)

Toggles colors display state.

Returns:

None

toggle_materials(self)

Toggles material display state.

Returns:

None

toggle_normals(self)

Toggles normals display state.

Returns:

None

toggle_sf(self)

Toggles SF display state.

Returns:

None

toggle_show_name(self)

Toggles name in 3D display state.

Returns:

None

toggle_visibility(self)

Toggles visibility.

Returns:

None

translate_gl(self, translation)

Translates current GL transformation by a rotation matrix.

Parameters:

translation (Annotated[numpy.typing.ArrayLike, numpy.float64,) –

Returns:

None