ImFusion SDK 4.3
ImFusion::AnatomyPlugin::StyleProperty Namespace Reference

List of known style "property-names". More...

Detailed Description

List of known style "property-names".

Functions

bool isColorPropertyName (std::string_view name)
 Returns true if the name corresponds to any of the color properties names.
 
const std::unordered_map< std::string, vec4 > & namedColors ()
 
bool isAlphaPropertyName (std::string_view name)
 Returns true if the name corresponds to any of the alpha properties names.
 
bool isVisibilityPropertyName (std::string_view name)
 Returns true if the name corresponds to any of the visibility properties names.
 
std::vector< std::stringpropertyNamesToOverwrite (const std::string &propertyName)
 Returns all of the property names that are written to for the given input propertyName Usually, this is just the propertyName itself.
 
StyleSheet createObjectAttributesOverrideStyle (const Properties &objectAttributes)
 Create a style sheet to extract those attributes that can be overriden by direct object attributes.
 

Variables

constexpr auto Visibility = "visibility"
 Visibility of the object, default for the more specific visibility properties and can be overwritten by them. (supported by: Graphs, Images, Keypoints, Meshes, Planes, PointClouds, Splines)
 
constexpr auto Color = "color"
 Color of the object, default for the more specific color properties and can be overwritten by them. (supported by: Graphs, Keypoints, Meshes, Planes, PointClouds, Splines)
 
constexpr auto Alpha = "alpha"
 Alpha value of the object, default for the more specific alpha properties and can be overwritten by them. (supported by: Graphs, Keypoints, Meshes, Planes, PointClouds, Splines)
 
constexpr auto ShowLabelText = "show_label_text"
 Flag if a text label shall be shown (supported by: Keypoints, Planes, PointClouds, Splines)
 
constexpr auto ShowLabelTextDebug = "show_label_text_debug"
 Flag if a text label with debug info shall be shown (supported by: Keypoints, Planes, PointClouds, Splines)
 
constexpr auto ShowOnlyPlaneNormals = "show_only_plane_normals"
 Flag if the plane normals shall be shown (supported by: Planes)
 
constexpr auto PlaneNormalLength = "plane_normal_length"
 The length of a rendered normal (supported by: Planes)
 
constexpr auto SmoothSpline = "smooth_spline"
 Flag if the spline shall be smoothed (supported by: Splines)
 
constexpr auto TubeThickness = "tube_thickness"
 Double defining the thickness of the rendered tube. If 0.0 no tube is rendered but a line. (supported by: Splines)
 
constexpr auto TubeEndT = "tube_end_t"
 Double defining the end of the fraction of the rendered tube [0.0, 1.0]. (supported by: Splines)
 
constexpr auto LineWidth = "line_width"
 Width of a line (supported by: Graphs, Meshes, Splines)
 
constexpr auto AsCrosshair = "as_crosshair"
 Flag to show a point as a crosshair (supported by: Keypoints)
 
constexpr auto PointSize = "point_size"
 Size of a point (supported by: Keypoints, Graphs, PointClouds, Splines)
 
constexpr auto LabelPixelOffset = "label_pixel_offset"
 vec2 defining the offset of the label in pixels to the object (supported by: Keypoints)
 
constexpr auto VisibilityOutline = "visibility_outline"
 Outline visibility of objects (supported by: Meshes)
 
constexpr auto ColorOutline = "color_outline"
 Outline color of objects (supported by: Meshes)
 
constexpr auto AlphaOutline = "alpha_outline"
 Outline alpha of objects (supported by: Meshes)
 
constexpr auto OutlineWidth = "outline_width"
 Outline width of objects (supported by: Meshes)
 
constexpr auto VisibilitySurface = "visibility_surface"
 Flag to show the surface of objects (supported by: Meshes)
 
constexpr auto ColorSurface = "color_surface"
 Surface color of objects (supported by: Meshes)
 
constexpr auto AlphaSurface = "alpha_surface"
 Surface alpha of objects (supported by: Meshes)
 
constexpr auto MaterialMode = "material_mode"
 Material mode (of the surface) of objects (supported by: Meshes, Pointclouds)
 
constexpr auto VisibilityCrossSection = "visibility_cross_section"
 Flag to show the cross-section of objects (supported by: Meshes)
 
constexpr auto ColorCrossSection = "color_cross_section"
 Cross-section color of objects (supported by: Meshes)
 
constexpr auto AlphaCrossSection = "alpha_cross_section"
 Cross-section alpha of objects (supported by: Meshes)
 
constexpr auto VisibilityWireframe = "visibility_wireframe"
 Flag to show the wireframe of objects (supported by: Meshes)
 
constexpr auto AlphaWireframe = "alpha_wireframe"
 Wireframe alpha of objects (supported by: Meshes)
 
constexpr auto ColorWireframe = "color_wireframe"
 Wireframe color of objects (supported by: Meshes)
 
constexpr auto VisibilityLine = "visibility_line"
 Flag to show the lines of objects (supported by: Graphs, Meshes)
 
constexpr auto ColorLine = "color_line"
 Line color of objects (supported by: Graphs, Meshes)
 
constexpr auto AlphaLine = "alpha_line"
 Line alpha of objects (supported by: Graphs, Meshes)
 
constexpr auto VisibilityPoint = "visibility_point"
 Flag to show the points of objects (supported by: Graphs)
 
constexpr auto ColorPoint = "color_point"
 Point color of objects (supported by: Graphs)
 
constexpr auto AlphaPoint = "alpha_point"
 Point alpha of objects (supported by: Graphs)
 
constexpr auto VisibilityCircleVisualization = "visibility_circle_visualization"
 Flag to show circle visualization of objects (supported by: Graphs)
 
constexpr auto ColorCircleVisualization = "color_circle_visualization"
 Circle visualization color of objects (supported by: Graphs)
 
constexpr auto AlphaCircleVisualization = "alpha_circle_visualization"
 Circle visualization alpha of objects (supported by: Graphs)
 
constexpr auto CircleVisualizationFeatureName = "circle_visualization_feature_name"
 Edge feature used as the diameter of circular loops drawn around edges. (supported by: Graphs)
 
constexpr auto LineBlendingEdgeFeatureName = "line_blending_edge_feature_name"
 Edge feature used as the color channel of lines. The values from this edge feature are mapped to a color with a given colormap and shown on the graph. (supported by: Graphs)
 
constexpr auto LineBlendingNodeFeatureName = "line_blending_node_feature_name"
 Node feature used as the alpha channel of lines. The values from this node feature are mapped to a color with a given colormap and shown on the graph. (supported by: Graphs)
 
constexpr auto OnlyDrawNontrivialNodes = "only_draw_nontrivial_nodes"
 Only draw nodes that don't have degree 2. This is useful for skipping intermediate nodes. For directed graphs we consider the out-degree (supported by: Graphs)
 
constexpr auto DrawDirectionOnLines = "draw_direction_on_lines"
 For directed graphs, draw arrows to indicate direction of lines. (supported by: Graphs)
 
constexpr auto ShowNodeLabels = "show_node_labels"
 Flag to show the node labels for the graph. (supported by: Graphs)
 
constexpr auto Colormap = "colormap"
 Colormap to use for the graph. (supported by: Graphs)
 
constexpr auto AllowObjectAttributesOverride = "allow_object_attributes_override"
 Whether to allow values directly specified in the object attributes to override those coming from the style sheets, for selected attributes such as the "color" attribute.
 

Function Documentation

◆ propertyNamesToOverwrite()

std::vector< std::string > propertyNamesToOverwrite ( const std::string & propertyName)

Returns all of the property names that are written to for the given input propertyName Usually, this is just the propertyName itself.

However, e.g. for the "color" property name, all property names that that start with "color_" are additionally written to (

See also
isColorPropertyName) and likewise for "alpha" and "visibility"

◆ createObjectAttributesOverrideStyle()

StyleSheet createObjectAttributesOverrideStyle ( const Properties & objectAttributes)

Create a style sheet to extract those attributes that can be overriden by direct object attributes.

See also
StylePropertyName::AllowObjectAttributesOverridee
Search Tab / S to search, Esc to close