Place¶

class wwt_data_formats.place.Place(**kwargs)[source]¶

Bases: wwt_data_formats.LockedXmlTraits, wwt_data_formats.abcs.UrlContainer

A place that can be visited.

Attributes Summary

`angle`	A float trait.
`angular_size`	A float trait.
`background_image_set`	A trait whose value must be an instance of a specified class.
`classification`	Use a Enum class as model for the data type description.
`constellation`	Use a Enum class as model for the data type description.
`data_set_type`	Use a Enum class as model for the data type description.
`dec_deg`	A float trait.
`distance`	A float trait.
`dome_alt`	A float trait.
`dome_az`	A float trait.
`foreground_image_set`	A trait whose value must be an instance of a specified class.
`image_set`	A trait whose value must be an instance of a specified class.
`latitude`	A float trait.
`longitude`	A float trait.
`magnitude`	A float trait.
`msr_community_id`	The ID number of the WWT Community that this content came from.
`msr_component_id`	The ID number of this content item on the WWT Communities system.
`name`	A trait for unicode strings.
`opacity`	A float trait.
`permission`	TBD.
`ra_hr`	A float trait.
`rotation_deg`	A float trait.
`thumbnail`	A trait for unicode strings.
`xmeta`	A trait whose value must be an instance of a specified class.
`zoom_level`	A float trait.

Methods Summary

as_imageset()

Return an ImageSet for this place if one is defined.

Attributes Documentation

angle¶: A float trait.

angular_size¶: A float trait.

background_image_set¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

classification¶

Use a Enum class as model for the data type description. Note that if no default-value is provided, the first enum-value is used as default-value.

# -- SINCE: Python 3.4 (or install backport: pip install enum34)
import enum
from traitlets import HasTraits, UseEnum

class Color(enum.Enum):
    red = 1         # -- IMPLICIT: default_value
    blue = 2
    green = 3

class MyEntity(HasTraits):
    color = UseEnum(Color, default_value=Color.blue)

entity = MyEntity(color=Color.red)
entity.color = Color.green    # USE: Enum-value (preferred)
entity.color = "green"        # USE: name (as string)
entity.color = "Color.green"  # USE: scoped-name (as string)
entity.color = 3              # USE: number (as int)
assert entity.color is Color.green

constellation¶

Use a Enum class as model for the data type description. Note that if no default-value is provided, the first enum-value is used as default-value.

# -- SINCE: Python 3.4 (or install backport: pip install enum34)
import enum
from traitlets import HasTraits, UseEnum

class Color(enum.Enum):
    red = 1         # -- IMPLICIT: default_value
    blue = 2
    green = 3

class MyEntity(HasTraits):
    color = UseEnum(Color, default_value=Color.blue)

entity = MyEntity(color=Color.red)
entity.color = Color.green    # USE: Enum-value (preferred)
entity.color = "green"        # USE: name (as string)
entity.color = "Color.green"  # USE: scoped-name (as string)
entity.color = 3              # USE: number (as int)
assert entity.color is Color.green

data_set_type¶

Use a Enum class as model for the data type description. Note that if no default-value is provided, the first enum-value is used as default-value.

# -- SINCE: Python 3.4 (or install backport: pip install enum34)
import enum
from traitlets import HasTraits, UseEnum

class Color(enum.Enum):
    red = 1         # -- IMPLICIT: default_value
    blue = 2
    green = 3

class MyEntity(HasTraits):
    color = UseEnum(Color, default_value=Color.blue)

entity = MyEntity(color=Color.red)
entity.color = Color.green    # USE: Enum-value (preferred)
entity.color = "green"        # USE: name (as string)
entity.color = "Color.green"  # USE: scoped-name (as string)
entity.color = 3              # USE: number (as int)
assert entity.color is Color.green

dec_deg¶: A float trait.

distance¶: A float trait.

dome_alt¶: A float trait.

dome_az¶: A float trait.

foreground_image_set¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

image_set¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

latitude¶: A float trait.

longitude¶: A float trait.

magnitude¶: A float trait.

msr_community_id¶: The ID number of the WWT Community that this content came from.

msr_component_id¶: The ID number of this content item on the WWT Communities system.

name¶: A trait for unicode strings.

opacity¶: A float trait.

permission¶: TBD.

ra_hr¶: A float trait.

rotation_deg¶: A float trait.

thumbnail¶: A trait for unicode strings.

xmeta¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

zoom_level¶: A float trait.

Methods Documentation

as_imageset()[source]¶

Return an ImageSet for this place if one is defined.

Returns

Either wwt_data_formats.imageset.ImageSet or None.

Notes

If the foreground_image_set of this Place is not None, it is returned. Otherwise, if its image_set is not None, that is returned. Otherwise, None is returned.

Place¶

Page Contents

Previous topic

Next topic

This Page

Navigation

Place¶