maptek.vulcan.dimension

There are several types of dimensions available in Vulcan. The base dimension object cannot be created, but all of the methods within it are available in the other classes.


Dimension types:

  • dim_angle

  • dim_arc

  • dim_line

  • dim_radius

maptek.vulcan.dimension (*args, **kwargs)

Base class for Vulcan design dimensions.

get_font (dimension self) → std::string

Gets the dimension font.

set_font (dimension self, std::string const & name)

Sets the dimension font.

get_scaled_text_height (dimension self) → double

Gets the dimension scaled text height.

get_text_height (dimension self) → double

Gets the dimension text height.

set_text_height (dimension self, double height)

Sets the dimension text height.

get_text_map_size (dimension self) → double

Gets the dimension text map size.

set_text_map_size (dimension self, double size)

Sets the dimension text map size.

get_scale (dimension self) → std::string

Gets the dimension scale.

get_scale_factor (dimension self, std::string const unit) → double

Gets the dimension scale factor.

set_scale (dimension self, std::string const & scale)

Sets the dimension scale.

get_label (dimension self) → std::string

Gets the dimension label.

set_label (dimension self, std::string const & label)

Sets the dimension label.

get_tick_offset (dimension self) → double

Gets the dimension tick offset.

set_tick_offset (dimension self, double offset)

Sets the dimension tick offset.

get_tick_gap (dimension self) → double

Gets the dimension tick gap.

set_tick_gap (dimension self, double gap)

Sets the dimension tick gap.

get_tick_extent_size (dimension self) → double

Gets the dimension tick extent size.

set_tick_extent_size (dimension self, double size)

Sets the dimension tick extent size.

is_mirrored_horizontally (dimension self) → bool

Returns the dimension mirror setting (horizontal).

set_mirrored_horizontally (dimension self, bool mirror=True)

Sets the dimension mirror setting (horizontal).

is_mirrored_vertically (dimension self) → bool

Returns the dimension mirror setting (vertical).

set_mirrored_vertically (dimension self, bool mirror=True)

Sets the dimension mirror setting (vertical).

get_arrow_length (dimension self) → double

Gets the dimension arrow length.

set_arrow_length (dimension self, double length)

Sets the dimension arrow length.

get_arrow_width (dimension self) → double

Gets the dimension arrow width.

set_arrow_width (dimension self, double width)

Sets the dimension arrow width.

font

Dimension font

text_height

Dimension text height

text_map_size

Dimension text map size

scale

Dimension scale

label

Dimension label

tick_offset

Dimension tick offset

tick_gap

Dimension tick gap

tick_extent_size

Dimension tick extent size

mirrored_horizontally

Dimension mirror (horizontal)

mirrored_vertically

Dimension mirror (vertical)

arrow_length

Dimension arrow length

arrow_width

Dimension arrow width


class

maptek.vulcan.dim_angle

Bases

maptek.vulcan.dimension

Interface for Vulcan design dimension angles.

get_origin (dim_angle self) → point

Gets the dimension origin.

set_origin (dim_angle self, point point)

Sets the dimension origin.

get_radius (dim_angle self) → point

Gets the dimension radius.

set_radius (dim_angle self, point point)

Sets the dimension radius.

get_sweep (dim_angle self) → point

Gets the dimension sweep.

set_sweep (dim_angle self, point point)

Sets the dimension sweep.

swap_points (dim_angle self)

Swaps the dimension points.

origin

Dimension origin point.

radius

Dimension radius point.

sweep

Dimension sweep point.


class

maptek.vulcan.dim_arc

Bases

maptek.vulcan.dimension

Interface for Vulcan design dimension arcs.

get_origin (dim_arc self) → point

Gets the dimension origin.

set_origin (dim_arc self, point point)

Sets the dimension origin.

get_radius (dim_arc self) → point

Gets the dimension radius.

set_radius (dim_arc self, point point)

Sets the dimension radius.

get_sweep (dim_arc self) → point

Gets the dimension sweep.

set_sweep (dim_arc self, point point)

Sets the dimension sweep.

swap_points (dim_arc self)

Swaps the dimension points.

origin

Dimension origin point.

radius

Dimension radius point.

sweep

Dimension sweep point.


class

maptek.vulcan.dim_line

Bases

maptek.vulcan.dimension

Interface for Vulcan design dimension lines.

get_start (dim_line self) → point

Gets the dimension start.

set_start (dim_line self, point point)

Sets the dimension start.

get_end (dim_line self) → point

Gets the dimension end.

set_end (dim_line self, point point)

Sets the dimension end.

midpoint (dim_line self) → point

Gets the dimension midpoint.

get_normal (dim_line self) → point

Gets the dimension normal.

set_normal (dim_line self, point point)

Sets the dimension normal.

swap_points (dim_line self)

Swaps the dimension points.

start

Dimension start point.

end

Dimension end point.

normal

Dimension normal direction.


class

maptek.vulcan.dim_radius

Bases

maptek.vulcan.dimension

Interface for Vulcan design dimension radii.

get_start (dim_radius self) → point

Gets the dimension start.

set_start (dim_radius self, point point)

Sets the dimension start.

get_end (dim_radius self) → point

Gets the dimension end.

set_end (dim_radius self, point point)

Sets the dimension end.

get_normal (dim_radius self) → point

Gets the dimension normal.

set_normal (dim_radius self, point point)

Sets the dimension normal.

swap_points (dim_radius self)

Swaps the dimension points.

start

Dimension start point.

end

Dimension end point.

normal

Dimension normal direction.