Class HierarchicalStateOverrideComponent
Controls the visualization of sub-hierarchies of entities.
class Microsoft::Azure::RemoteRendering::HierarchicalStateOverrideComponent final : public Microsoft::Azure::RemoteRendering::ComponentBase
Methods
GetState
Returns the current enabled state of a feature.
- A Result.InvalidParam error occurs if 'feature' is an invalid bitmask.
- A Result.InvalidParam error occurs if 'enabledState' is an invalid value.
auto GetState(Microsoft::Azure::RemoteRendering::HierarchicalStates feature) noexcept -> Expected<Microsoft::Azure::RemoteRendering::HierarchicalEnableState, Microsoft::Azure::RemoteRendering::Status>;
Parameters
| Name | Type | Description |
|---|---|---|
feature |
HierarchicalStates | A single feature to query the current status on. Unlike SetState, multiple feature bits cannot be combined here. |
Returns
| Type | Description |
|---|---|
| HierarchicalEnableState |
SetState
Sets specific features to a new state of type HierarchicalEnableState.
- A Result.InvalidParam error occurs if 'feature' is an invalid bitmask.
- A Result.InvalidParam error occurs if 'enabledState' is an invalid value.
auto SetState(Microsoft::Azure::RemoteRendering::HierarchicalStates feature, Microsoft::Azure::RemoteRendering::HierarchicalEnableState enabledState) noexcept -> Microsoft::Azure::RemoteRendering::Status;
Parameters
| Name | Type | Description |
|---|---|---|
feature |
HierarchicalStates | The feature(s) to modify. A bitwise combination of features can be passed here to modify multiple features simultaneously. |
enabledState |
HierarchicalEnableState | The new state. |
Properties
CutPlaneFilterMask
The cut plane filter mask of this component. This mask is effectively used by the geometry if the HierarchicalStates.UseCutPlaneFilterMask flag is set.
auto GetCutPlaneFilterMask() const noexcept -> unsigned char;
auto SetCutPlaneFilterMask(unsigned char value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
DisableCollisionState
Wraps around GetState/SetState for the HierarchicalStates.DisableCollision feature.
auto GetDisableCollisionState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetDisableCollisionState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
HiddenState
Wraps around GetState/SetState for the HierarchicalStates.Hidden feature.
auto GetHiddenState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetHiddenState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
OverrideMaterial
A single material for rendering the geometry that is activated through the HierarchicalStates.UseOverrideMaterial flag.
This can be an arbitrary PbrMaterial or a ColorMaterial, but some features may not work if the geometry does not have the required vertex streams, e.g. normals for proper PBR lighting or texture UV coordinates for texture mapping. Using a transparent material on opaque geometry will only work reliably in ServiceRenderMode.TileBasedComposition. Point cloud geometry is not affected by this feature. By default, the material reference is unassigned which has the same effect as disabling the feature through the HierarchicalStates.UseOverrideMaterial flag.
auto GetOverrideMaterial() const noexcept -> ApiHandle<Microsoft::Azure::RemoteRendering::Material>;
auto SetOverrideMaterial(ApiHandle<Microsoft::Azure::RemoteRendering::Material> const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
SeeThroughState
Wraps around GetState/SetState for the HierarchicalStates.SeeThrough feature.
auto GetSeeThroughState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetSeeThroughState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
SelectedState
Wraps around GetState/SetState for the HierarchicalStates.Selected feature.
auto GetSelectedState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetSelectedState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
ShellState
Wraps around GetState/SetState for the HierarchicalStates.Shell feature.
auto GetShellState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetShellState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
TintColor
The color to use for tinting the meshes below this node.
The tint color is only used if the HierarchicalStateOverrideComponent.UseTintColorState is set to HierarchicalEnableState.ForceOn.
auto GetTintColor() const noexcept -> Microsoft::Azure::RemoteRendering::Color4Ub;
auto SetTintColor(Microsoft::Azure::RemoteRendering::Color4Ub const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
TransparencyWritesDepthState
Wraps around GetState/SetState for the HierarchicalStates.TransparencyWritesDepth feature.
auto GetTransparencyWritesDepthState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetTransparencyWritesDepthState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
UseCutPlaneFilterMaskState
Wraps around GetState/SetState for the HierarchicalStates.UseCutPlaneFilterMask feature
auto GetUseCutPlaneFilterMaskState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetUseCutPlaneFilterMaskState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
UseOverrideMaterialState
Wraps around GetState/SetState for the HierarchicalStates.UseOverrideMaterial feature.
auto GetUseOverrideMaterialState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetUseOverrideMaterialState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
UseTintColorState
Wraps around GetState/SetState for the HierarchicalStates.UseTintColor feature.
auto GetUseTintColorState() const noexcept -> Microsoft::Azure::RemoteRendering::HierarchicalEnableState;
auto SetUseTintColorState(Microsoft::Azure::RemoteRendering::HierarchicalEnableState value) noexcept -> Microsoft::Azure::RemoteRendering::Status;